Skip to content

Gateway HTTP reference

The gateway exposes a control plane and runs surface over HTTP. This page is the human-readable index; the OpenAPI spec is the machine-readable source of truth.

Auth

All routes require a bearer token unless explicitly noted. Configure tokens via gateway config or environment. Unauthenticated requests get 401.

Health & metrics

MethodPathDescription
GET/healthLiveness probe; returns {status}
GET/metricsPrometheus-format metrics

Gateway lifecycle

MethodPathDescription
POST/gateway/pauseStop accepting new runs
POST/gateway/resumeResume accepting new runs
POST/gateway/reloadRe-read pipelines and config

Pipelines

MethodPathDescription
GET/pipelinesList registered pipelines
GET/pipelines/:idDescribe one pipeline
POST/pipelines/:id/runRun a pipeline synchronously
POST/pipelines/:id/startStart an async run; returns runId

Runs

MethodPathDescription
GET/runs/:runIdGet run record
GET/runs/:runId/eventsSSE/JSONL event stream for a run
POST/runs/:runId/resumeResume a waiting run
POST/runs/:runId/approveApprove a paused approval gate
POST/runs/:runId/denyDeny a paused approval gate

Approvals

MethodPathDescription
GET/approvalsList pending approvals

Triggers

MethodPathDescription
GET/triggersList registered triggers
POST/triggers/:id/fireManually fire a trigger

Schedules

MethodPathDescription
GET/schedulesList schedules
POST/schedulesAdd a schedule
DELETE/schedules/:idRemove a schedule

Sessions

MethodPathDescription
GET/sessionsList ACP sessions
GET/sessions/:idGet one session
POST/sessions/:id/resumeResume a session
POST/sessions/prunePrune expired/old sessions
DELETE/sessions/:idDrop a session

Debug

MethodPathDescription
GET/debug/breakpointsList active breakpoints
POST/debug/breakpointsAdd a breakpoint
DELETE/debug/breakpoints/:stepIdRemove a breakpoint
GET/debug/runsList runs paused at breakpoints
POST/debug/runs/:runId/releaseRelease a paused run

OpenAI compatibility (optional surface)

MethodPathDescription
POST/v1/chat/completionsOpenAI-compatible chat surface
POST/v1/responsesOpenAI-compatible responses API

See also

Released under the MIT License.