Start connected agent runtime run
POST
/v1/servers/{serverId}/runtime/agent/runsHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| serverId | path | string | Yes | Resource ID |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| content | string | No | Raw text content. |
| prompt | string | No | — |
| title | string | No | Display title. |
| mode | sync | async | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Connected runtime run startedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| serverId | string | No | Resource ID. |
| agentRuntimeId | string | No | — |
| run | object | No | — |
| run.id | string | No | Unique identifier. |
| run.serverId | string | No | Resource ID. |
| run.threadId | string | No | Thread ID. |
| run.title | string | No | Display title. |
| run.input | string | No | — |
| run.output | string | No | — |
| run.mode | sync | async | No | — |
| run.status | queued | running | completed | failed | cancelled | No | Current lifecycle status. |
| run.error | string | No | — |
| run.metadata | object | No | Free-form metadata object. |
| run.createdAt | string | No | ISO 8601 timestamp. |
| run.completedAt | string | No | ISO 8601 timestamp. |
| run.sessionProtocol | string | No | — |
| run.threadBacked | boolean | No | — |
| run.threadStatus | string | No | — |
| run.threadTitle | string | No | — |
| thread | object | No | — |
| events | object[] | No | — |
| events[].id | string | No | Unique identifier. |
| events[].role | string | No | — |
| events[].content | string | No | Raw text content. |
| events[].logType | string | No | — |
| events[].logLevel | string | No | — |
| events[].createdAt | string | No | ISO 8601 timestamp. |
202Connected runtime run acceptedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| serverId | string | No | Resource ID. |
| agentRuntimeId | string | No | — |
| run | object | No | — |
| run.id | string | No | Unique identifier. |
| run.serverId | string | No | Resource ID. |
| run.threadId | string | No | Thread ID. |
| run.title | string | No | Display title. |
| run.input | string | No | — |
| run.output | string | No | — |
| run.mode | sync | async | No | — |
| run.status | queued | running | completed | failed | cancelled | No | Current lifecycle status. |
| run.error | string | No | — |
| run.metadata | object | No | Free-form metadata object. |
| run.createdAt | string | No | ISO 8601 timestamp. |
| run.completedAt | string | No | ISO 8601 timestamp. |
| run.sessionProtocol | string | No | — |
| run.threadBacked | boolean | No | — |
| run.threadStatus | string | No | — |
| run.threadTitle | string | No | — |
| thread | object | No | — |
| events | object[] | No | — |
| events[].id | string | No | Unique identifier. |
| events[].role | string | No | — |
| events[].content | string | No | Raw text content. |
| events[].logType | string | No | — |
| events[].logLevel | string | No | — |
| events[].createdAt | string | No | ISO 8601 timestamp. |
Start connected agent runtime run
Loading...
Response 201
Loading...