API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deployments

Create Deployment

client.agents.deployments.create(stringagentID, DeploymentCreateParams { docker_image, helm_release_name, registration_metadata, sgp_deploy_id } body, RequestOptionsoptions?): DeploymentCreateResponse { id, agent_id, docker_image, 9 more }

POST/agents/{agent_id}/deployments

List Deployments

client.agents.deployments.list(stringagentID, DeploymentListParams { limit, order_by, order_direction, page_number } query?, RequestOptionsoptions?): DeploymentListResponse { id, agent_id, docker_image, 9 more }

GET/agents/{agent_id}/deployments

Get Deployment

client.agents.deployments.retrieve(stringdeploymentID, DeploymentRetrieveParams { agent_id } params, RequestOptionsoptions?): DeploymentRetrieveResponse { id, agent_id, docker_image, 9 more }

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

Delete Deployment

client.agents.deployments.delete(stringdeploymentID, DeploymentDeleteParams { agent_id } params, RequestOptionsoptions?): DeleteResponse { id, message }

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

Promote Deployment

client.agents.deployments.promote(stringdeploymentID, DeploymentPromoteParams { agent_id } params, RequestOptionsoptions?): DeploymentPromoteResponse { id, agent_id, docker_image, 9 more }

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

Preview RPC

client.agents.deployments.previewRpc(stringdeploymentID, DeploymentPreviewRpcParams { agent_id, method, params, 2 more } params, RequestOptionsoptions?): AgentRpcResponse { result, id, error, jsonrpc }

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

ModelsExpand Collapse

DeploymentCreateResponse { 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" | "Ready" | "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url?: string | null

ACP URL set when agent registers.

created_at?: string | null

When the deployment was created.

formatdate-time

expires_at?: string | null

When marked for cleanup.

formatdate-time

helm_release_name?: string | null

Helm release name for cleanup.

promoted_at?: string | null

When promoted to production.

formatdate-time

registration_metadata?: Record<string, unknown> | null

Git/build metadata from the agent pod.

sgp_deploy_id?: string | null

Correlates to SGP’s agentex_deploys.id.

DeploymentListResponse = Array<DeploymentListResponseItem>

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" | "Ready" | "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url?: string | null

ACP URL set when agent registers.

created_at?: string | null

When the deployment was created.

formatdate-time

expires_at?: string | null

When marked for cleanup.

formatdate-time

helm_release_name?: string | null

Helm release name for cleanup.

promoted_at?: string | null

When promoted to production.

formatdate-time

registration_metadata?: Record<string, unknown> | null

Git/build metadata from the agent pod.

sgp_deploy_id?: string | null

Correlates to SGP’s agentex_deploys.id.

DeploymentRetrieveResponse { 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" | "Ready" | "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url?: string | null

ACP URL set when agent registers.

created_at?: string | null

When the deployment was created.

formatdate-time

expires_at?: string | null

When marked for cleanup.

formatdate-time

helm_release_name?: string | null

Helm release name for cleanup.

promoted_at?: string | null

When promoted to production.

formatdate-time

registration_metadata?: Record<string, unknown> | null

Git/build metadata from the agent pod.

sgp_deploy_id?: string | null

Correlates to SGP’s agentex_deploys.id.

DeploymentPromoteResponse { 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" | "Ready" | "Failed"

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url?: string | null

ACP URL set when agent registers.

created_at?: string | null

When the deployment was created.

formatdate-time

expires_at?: string | null

When marked for cleanup.

formatdate-time

helm_release_name?: string | null

Helm release name for cleanup.

promoted_at?: string | null

When promoted to production.

formatdate-time

registration_metadata?: Record<string, unknown> | null

Git/build metadata from the agent pod.

sgp_deploy_id?: string | null

Correlates to SGP’s agentex_deploys.id.