HTTP API
Endpoints
Call Studio routes from scripts, tests, or custom internal tools.
Studio exposes the same runtime used by the bundled UI as an HTTP API.
Core Endpoints
| Endpoint | Method | Purpose |
|---|---|---|
/health | GET | Check that the runtime is alive |
/config | GET | Read agents, quick prompts, and enabled capabilities |
/agents | GET | List registered agents |
/agents/:agentId | GET | Read one agent config |
/agents/:agentId/tools | GET | Inspect registered tool metadata for one agent |
/agents/:agentId/mcps | GET | Inspect registered MCP server and tool metadata for one agent |
/agents/:agentId/runs | POST | Run an agent |
/pipelines | GET | List registered pipelines |
/pipelines/:pipelineId | GET | Read pipeline metadata and graph |
/pipelines/:pipelineId/runs | POST | Run a pipeline with JSON input |
/pipelines/:pipelineId/logs | GET | Read metadata-only pipeline audit logs |
/sessions | GET, POST | List or create sessions |
/sessions/:sessionId | GET, DELETE | Read or delete a session |
/sessions/:sessionId/logs | GET | Read metadata-only session audit logs |
/sessions/:sessionId/traces | GET | List traces for a session |
/traces | GET | List traces |
/traces/:traceId | GET | Read one trace |
/approvals | GET | List pending or resolved approvals |
/approvals/:approvalId/decision | POST | Approve or reject a tool call |
/questions | GET | List pending or answered human question requests |
/questions/:questionId/answer | POST | Answer an ask_question tool request |
/knowledge | GET | Inspect agent context, dynamic retrieval sources, and recent trace evidence |
Error Shape
{
"error": {
"code": "bad_request",
"message": "Request body must be JSON"
}
}Error codes are bad_request, conflict, not_found, unsupported_capability, and internal_error.
For request examples, see Run Requests, Streaming Runs, Tool Approvals, and Human Questions.