StudioRuntime endpoints

Runtime endpoints

Understand the APIs Studio maps under the configured base path.

Studio maps runtime APIs under the configured base path.

With Path = "/studio":

HTTP
GET  /studio/metadata/agents
GET  /studio/metadata/tools
GET  /studio/metadata/context-spaces
POST /studio/api/agents/{agentId}/chat
POST /studio/api/tools/{toolName}/run
GET  /studio/api/workflows
GET  /studio/api/workflows/{workflowId}
POST /studio/api/workflows/{workflowId}/run
GET  /studio/api/context-spaces/{contextSpaceId}/source-documents
GET  /studio/api/context-spaces/{contextSpaceId}/source-documents/preview
GET  /studio/api/context-spaces/{contextSpaceId}/skill-documents
GET  /studio/api/context-spaces/{contextSpaceId}/skill-documents/preview

These APIs are primarily used by Studio, but they are useful to understand when debugging local behavior.

Agent chat

HTTP
POST /studio/api/agents/{agentId}/chat
Content-Type: application/json

{
  "message": "Create a practical two-day Istanbul trip plan.",
  "responseMode": "Stream"
}

Stream returns server-sent events. Result returns one JSON response with final message and execution steps.

Tool run

HTTP
POST /studio/api/tools/{toolName}/run
Content-Type: application/json

{
  "input": {
    "city": "Istanbul"
  }
}

Workflow run

HTTP
POST /studio/api/workflows/{workflowId}/run
Content-Type: application/json

{
  "input": "Create a practical two-day Istanbul trip plan."
}

Context previews

Context Space document and skill preview APIs are read-only and intended for Studio inspection.

On this page