Skip to content
warren
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Start here
Quickstart
Project setup
Concepts
Constitution
Philosophy
Runtime providers
Self-host
Kubernetes
Reference
CLI reference
Labels
API
Overview
agents
Overview
/agents
GET
/agents/{name}
GET
alerts
Overview
/alerts/heal
POST
analytics
Overview
/analytics/behavior
GET
/analytics/cost
GET
/analytics/dispatch
GET
/analytics/runs
GET
events
Overview
/events
GET
/events/stream
GET
extensions
Overview
/extensions/judge/verdicts.jsonl
GET
forge
Overview
/forge/repos
GET
github-app
Overview
/github-app/callback
GET
/github-app/installed
GET
/github-app/register
GET
instance
Overview
/instance
GET
meta
Overview
/healthz
GET
/readyz
GET
/version
GET
metrics
Overview
/metrics
GET
ops
Overview
/ops/overview
GET
plan-runs
Overview
/plan-runs
GET
/plan-runs
POST
/plan-runs/{id}
GET
/plan-runs/{id}/cancel
POST
/plan-runs/{id}/events
GET
/plan-runs/{id}/resume
POST
preview
Overview
/preview/config
GET
projects
Overview
/projects
GET
/projects
POST
/projects/{id}
GET
/projects/{id}
DELETE
/projects/{id}/ready-plans
GET
/projects/{id}/refresh
POST
/projects/{id}/seeds/{seedId}
GET
/projects/{id}/seeds/plans
GET
/projects/{id}/triggers
GET
/projects/{id}/triggers/{triggerId}/run
POST
/projects/{id}/warren-config
GET
runs
Overview
/runs
GET
/runs
POST
/runs/{id}
GET
/runs/{id}/cancel
POST
/runs/{id}/events
GET
/runs/{id}/finalize-intent
GET
/runs/{id}/finalize-result
POST
/runs/{id}/git-credential
POST
/runs/{id}/inbox
GET
/runs/{id}/preview/login
POST
/runs/{id}/preview/teardown
POST
/runs/{id}/salvage
POST
/runs/{id}/steer
POST
setup
Overview
/setup
GET
whoami
Overview
/whoami
GET
SDK
Classes
WarrenClient
WarrenClientError
WarrenUnreachableError
Interfaces
ActorCapabilities
AgentRow
CancelPlanRunResponse
CancelRunInput
CancelRunResponse
CreatePlanRunInput
CreatePlanRunResponse
CreateProjectInput
CreateRunInput
DispatchAnalytics
DispatchCountBucket
DispatchRunInput
ErrorEnvelope
GetRunResponse
InboxMessage
ListAgentsResponse
ListPlanRunsFilter
ListPlanRunsResponse
ListProjectsResponse
ListReadyPlansResponse
ListRunsResponse
PlanRunChildRow
PlanRunDetailResponse
PlanRunRow
ProjectRow
ReadyPlan
RefreshProjectInput
RefreshProjectResponse
RunEvent
RunRow
SpawnRunResponse
SteerRunInput
SteerRunResponse
StreamPlanRunEventsOptions
StreamRunEventsOptions
VersionResponse
WaitForPlanRunOptions
WaitForRunOptions
WarrenClientConfig
WarrenClientOptions
WhoamiResponse
Type Aliases
ActorIdentity
ActorKind
AgentSource
ApiErrorEnvelope
CapabilityName
CloneKind
DispatchAnalyticsResponse
DispatchAnalyticsRow
EnvLike
EventStream
ForgeErrorKind
InboxState
MessagePriority
PlanRunChildState
PlanRunState
PlanRunTerminalState
PreviewState
PullRequestLifecycle
RunCostBasis
RunFailureReason
RunMode
RunState
RunTerminalState
Variables
DEFAULT_POLL_INTERVAL_MS
DEFAULT_POLL_TIMEOUT_MS
DEFAULT_PROBE_TIMEOUT_MS
DEFAULT_WARREN_BASE_URL
PLAN_RUN_TERMINAL_STATES
RUN_TERMINAL_STATES
Functions
isPullRequestLifecycle
isTerminalPlanRunState
isTerminalRunState
loadWarrenClientConfigFromEnv
GitHub
Select theme
Dark
Light
Auto
Overview
agents
Section titled “agents”
/agents
routes.
Operations
Section titled “Operations”
GET
/agents
GET
/agents/{name}