API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deployments

Create Deployment

agents.deployments.create(stragent_id, DeploymentCreateParams**kwargs) -> DeploymentCreateResponse

POST/agents/{agent_id}/deployments

List Deployments

agents.deployments.list(stragent_id, DeploymentListParams**kwargs) -> DeploymentListResponse

GET/agents/{agent_id}/deployments

Get Deployment

agents.deployments.retrieve(strdeployment_id, DeploymentRetrieveParams**kwargs) -> DeploymentRetrieveResponse

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

Delete Deployment

agents.deployments.delete(strdeployment_id, DeploymentDeleteParams**kwargs) -> DeleteResponse

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

Promote Deployment

agents.deployments.promote(strdeployment_id, DeploymentPromoteParams**kwargs) -> DeploymentPromoteResponse

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

Preview RPC

agents.deployments.preview_rpc(strdeployment_id, DeploymentPreviewRpcParams**kwargs) -> AgentRpcResponse

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

ModelsExpand Collapse

class DeploymentCreateResponse: …

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

List[DeploymentListResponseItem]

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

class DeploymentRetrieveResponse: …

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

class DeploymentPromoteResponse: …

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.