API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deployments

Create Deployment

POST/agents/{agent_id}/deployments

List Deployments

GET/agents/{agent_id}/deployments

Get Deployment

GET/agents/{agent_id}/deployments/{deployment_id}

Delete Deployment

DELETE/agents/{agent_id}/deployments/{deployment_id}

Promote Deployment

POST/agents/{agent_id}/deployments/{deployment_id}/promote

Preview RPC

POST/agents/{agent_id}/deployments/{deployment_id}/rpc

ModelsExpand Collapse

DeploymentCreateResponse object { id, agent_id, docker_image, 9 more }

id: string

The unique identifier of the deployment.

agent_id: string

The agent this deployment belongs to.

docker_image: string

Full Docker image URI.

is_production: boolean

Whether this is the production deployment.

status: "Pending" or "Ready" or "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: optional string

ACP URL set when agent registers.

created_at: optional string

When the deployment was created.

formatdate-time

expires_at: optional string

When marked for cleanup.

formatdate-time

helm_release_name: optional string

Helm release name for cleanup.

promoted_at: optional string

When promoted to production.

formatdate-time

registration_metadata: optional map[unknown]

Git/build metadata from the agent pod.

sgp_deploy_id: optional string

Correlates to SGP’s agentex_deploys.id.

DeploymentListResponse = array of object { id, agent_id, docker_image, 9 more }

id: string

The unique identifier of the deployment.

agent_id: string

The agent this deployment belongs to.

docker_image: string

Full Docker image URI.

is_production: boolean

Whether this is the production deployment.

status: "Pending" or "Ready" or "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: optional string

ACP URL set when agent registers.

created_at: optional string

When the deployment was created.

formatdate-time

expires_at: optional string

When marked for cleanup.

formatdate-time

helm_release_name: optional string

Helm release name for cleanup.

promoted_at: optional string

When promoted to production.

formatdate-time

registration_metadata: optional map[unknown]

Git/build metadata from the agent pod.

sgp_deploy_id: optional string

Correlates to SGP’s agentex_deploys.id.

DeploymentRetrieveResponse object { id, agent_id, docker_image, 9 more }

id: string

The unique identifier of the deployment.

agent_id: string

The agent this deployment belongs to.

docker_image: string

Full Docker image URI.

is_production: boolean

Whether this is the production deployment.

status: "Pending" or "Ready" or "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: optional string

ACP URL set when agent registers.

created_at: optional string

When the deployment was created.

formatdate-time

expires_at: optional string

When marked for cleanup.

formatdate-time

helm_release_name: optional string

Helm release name for cleanup.

promoted_at: optional string

When promoted to production.

formatdate-time

registration_metadata: optional map[unknown]

Git/build metadata from the agent pod.

sgp_deploy_id: optional string

Correlates to SGP’s agentex_deploys.id.

DeploymentPromoteResponse object { id, agent_id, docker_image, 9 more }

id: string

The unique identifier of the deployment.

agent_id: string

The agent this deployment belongs to.

docker_image: string

Full Docker image URI.

is_production: boolean

Whether this is the production deployment.

status: "Pending" or "Ready" or "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: optional string

ACP URL set when agent registers.

created_at: optional string

When the deployment was created.

formatdate-time

expires_at: optional string

When marked for cleanup.

formatdate-time

helm_release_name: optional string

Helm release name for cleanup.

promoted_at: optional string

When promoted to production.

formatdate-time

registration_metadata: optional map[unknown]

Git/build metadata from the agent pod.

sgp_deploy_id: optional string

Correlates to SGP’s agentex_deploys.id.