Agents
Show an agent deployment
GET /v1/agent-deployments/{id} · SDK getAgentDeployment · CLI deployments deployment show
GET
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
id*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$AgentDeploymentResponse
application/json- response
createdAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeupdatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeversion*integerRange
0 <= value <= 9007199254740991environmentId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$projectId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentDefinitionId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentReleaseId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$candidateAgentReleaseId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$candidateStartedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecandidateWeight?integerRange
1 <= value <= 99currentState*stringValue in
"deploying""failed""paused""ready""stopped"desiredState*stringValue in
"paused""running""stopped"id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$lastTransitionAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeruntimeConfig?curl -X GET "https://example.com/v1/agent-deployments/string" \ -H "x-deployments-environment: string"{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "environmentId": "string", "organizationId": "string", "projectId": "string", "agentDefinitionId": "string", "agentReleaseId": "string", "candidateAgentReleaseId": "string", "candidateStartedAt": "2019-08-24T14:15:22Z", "candidateWeight": 1, "currentState": "deploying", "desiredState": "paused", "id": "string", "lastTransitionAt": "2019-08-24T14:15:22Z", "runtimeConfig": { "agentBindings": {}, "apiVersion": "agents.deployments.ai/v1", "brainRetrievalMode": "brain-first", "kind": "AgentDeploymentConfig", "toolAuthorizations": {} }}