Skip to content

HTTP API Reference

The Debug Server provides a JSON API for Graph Definitions, immutable Sessions, Runs, runtime inspection, registry discovery, memory, chat channels, and Triggers. All paths below are relative to the optional -prefix.

Authentication

GET /healthz and public Trigger invocation routes do not use management authentication. Graph, Run, registry, memory, assistant, and Trigger management routes require:

http
Authorization: Bearer <WEAVEFLOW_MANAGEMENT_TOKEN>

Use HTTPS or a private network when sending the token. A non-loopback server refuses to start without one.

Graph lifecycle

MethodPathPurpose
GET/graphsList graph summaries.
GET/graphs/:graph_idRead graph detail and registry-resolved metadata.
DELETE/graphs/:graph_idDelete a Graph and its retained runtime data.
GET/graphs/:graph_id/retention-auditReview retained data before deletion or cleanup.
POST/graphs/:graph_id/sessionsCreate an immutable Graph Session.
GET/graphs/:graph_id/sessions/:session_idRead Session detail.
POST/graphs/:graph_id/analysis/initial-state-requirementsAnalyze required initial State.

Definitions are validated before a Session is created. Treat the returned Session ID as the execution identity.

Runtime and registry

MethodPathPurpose
GET/registryDiscover node, condition, module, capability, and reducer contracts.
GET/runtime/toolsList tools installed in the runtime context.

Runs and evidence

MethodPathPurpose
POST/graphs/:graph_id/sessions/:session_id/runsStart a Run.
GET/graphs/:graph_id/runsList Runs for a graph.
GET/graphs/:graph_id/runs/:run_id/inspectionRead summary, Steps, State, and diagnostics.
GET/graphs/:graph_id/runs/:run_id/eventsRead paged Events.
GET/graphs/:graph_id/events/streamStream graph-scoped runtime Events with SSE.
GET/graphs/:graph_id/runs/:run_id/checkpoints/:checkpoint_idRead a checkpoint.
GET/graphs/:graph_id/runs/:run_id/artifactsList Run Artifacts.
GET/graphs/:graph_id/runs/:run_id/artifacts/:artifact_idRead one Artifact.
POST/graphs/:graph_id/runs/:run_id/pauseRequest a safe pause.
POST/graphs/:graph_id/runs/:run_id/resumeResume from a compatible checkpoint.
POST/graphs/:graph_id/runs/:run_id/steps/:step_id/effect-resolutionRecord the outcome of an unresolved side effect.
POST/graphs/:graph_id/runs/:run_id/cancelCancel a Run.
DELETE/graphs/:graph_id/runs/:run_idDelete a Run and its retained evidence.
POST/graphs/:graph_id/runs/:run_id/forksFork a Run from retained evidence.
GET/graphs/:graph_id/runs/:run_id/compare/:other_run_idCompare two Runs.

Request and response bodies are versioned with the server. Use the registry and a created Session to discover the exact State and settings accepted by a graph instead of assuming every node has the same input shape.

Memory, Assistant, and chat

Memory management uses /memory/:namespace for list, search, read, write, and delete operations. The optional Assistant service uses /assistant/status, /assistant/sessions/:session_id, /assistant/sessions/:session_id/messages, /assistant/jobs/:job_id, and /assistant/jobs/:job_id/stream. Chat channel setup uses:

text
/chat-channels/:channel_id/setup-sessions
/chat-channels/:channel_id/setup-sessions/:session_id/verification

Triggers

Trigger management lives at /graphs/:graph_id/triggers (GET to list and PUT to replace). Public invocation endpoints are:

  • POST /graphs/:graph_id/triggers/:trigger_id/invocations
  • POST /graphs/:graph_id/triggers/:trigger_id/webhook
  • POST /graphs/:graph_id/triggers/:trigger_id/chat

Validate channel credentials through the setup workflow before replacing a graph's Trigger configuration.

Health and errors

bash
curl -i http://127.0.0.1:8080/healthz

The health response includes server status, version, and UTC build time. Errors are JSON responses with a status-specific message; preserve the response body and related Event IDs when opening an incident.

Released under the MIT License.