List agent deployments
List the current and historical traffic deployments for an agent.
Endpoint
GET
/api/v1/workspaces/{workspace_id}/agents/{agent_id}/deploymentsAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| customer-api | Bearer API key or dashboard session cookie; dashboard mutations also require X-CX-Request: 1. | member | Allowed |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
workspace_id | path | string | Yes | — |
agent_id | path | string | Yes | — |
cursor | query | string or null | No | — |
limit | query | integer | No | — |
Request body
This operation has no request body.
Example
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/agents/agt_demo/deployments' \ --header 'Authorization: Bearer YOUR_API_KEY'
Responses
| Status | Description | Content |
|---|---|---|
4XX | Handled client error | application/json: ErrorResponse |
200 | Successful Response | application/json: DeploymentStateResponse |
4XX application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ErrorResponse | — | No | Yes | — | — |
error | object | ErrorItem | — | No | Yes | — | — |
error.code | string | — | — | No | Yes | — | — |
error.details | object | — | — | No | No | — | — |
error.message | string | — | — | No | Yes | — | — |
200 application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | DeploymentStateResponse | — | No | Yes | — | — |
distribution | array<TrafficAllocation> | — | — | No | Yes | — | — |
distribution[] | object | TrafficAllocation | — | No | Yes | — | — |
distribution[].basis_points | integer | — | — | No | Yes | — | — |
distribution[].branch_id | string | — | — | No | Yes | — | — |
distribution[].percentage | string | — | — | No | Yes | — | — |
history | array<Deployment> | — | — | No | Yes | — | — |
history[] | object | Deployment | — | No | Yes | — | — |
history[].created_at | string | — | date-time | No | Yes | — | — |
history[].created_by | object | DeploymentActor | — | No | Yes | — | — |
history[].created_by.id | string or null | — | — | Yes | Yes | — | — |
history[].created_by.name | string | — | — | No | Yes | — | — |
history[].distribution | array<TrafficAllocation> | — | — | No | Yes | — | — |
history[].distribution[] | object | TrafficAllocation | — | No | Yes | — | — |
history[].distribution[].basis_points | integer | — | — | No | Yes | — | — |
history[].distribution[].branch_id | string | — | — | No | Yes | — | — |
history[].distribution[].percentage | string | — | — | No | Yes | — | — |
history[].id | string | — | — | No | Yes | — | — |
next_cursor | string or null | — | — | Yes | Yes | — | — |
Response example
{
"distribution": [],
"history": [],
"next_cursor": "string"
}Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.
| Status | Code | Description |
|---|---|---|
401 | unauthenticated | Authentication is missing, invalid, or revoked. |
403 | forbidden | The authenticated caller does not have access to this operation. |
404 | not_found | The requested workspace resource was not found. |