v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB

Agents

Get Deployment

Get a deployment by its ID.

get/agents/deployments/{deployment_id}

Path parameters

deployment_idstring required

The ID of the deployment.

Headers

Cartesia-Version'2026-03-01' date required

Example:2026-03-01

API version header.

Response

idstring required

The unique identifier for the deployment.

agent_idstring required

The ID of the agent associated with this deployment.

version_idstring required

The ID of the agent version associated with this deployment.

statusstring required

The current status of the deployment. It can be queued, inactive, deploy_error, skipped, build_error, building, built, deploying, or deployed.

is_pinnedboolean required

Marks that this deployment is the active deployment for its associated agent_id. Only one deployment per agent can be pinned at a time. Deployments can be pinned even if they are not live or failed.

is_liveboolean required

True if this deployment is the live production deployment for its associated agent_id. Only one deployment per agent can be live at a time.

env_var_collection_idstring nullable

The ID of the environment variable collection associated with this deployment.

source_code_file_idstring nullable

The ID of the source code file associated with this deployment.

git_commit_hashstring nullable

The commit hash of the Git repository for this deployment.

created_atstring date-time required

The UTC timestamp when the deployment was created.

updated_atstring date-time required

The UTC timestamp when the deployment was last updated.

build_completed_atstring date-time nullable

The UTC timestamp when the build was completed.

build_errorstring nullable

Any error that occurred during the build process.

build_logsstring nullable

Logs generated during the build process of the deployment.

build_started_atstring date-time nullable

The UTC timestamp when the build process started.

deployment_started_atstring date-time nullable

The UTC timestamp when the deployment process started.

deployment_completed_atstring date-time nullable

The UTC timestamp when the deployment process was completed.

deployment_errorstring nullable

Any error that occurred during the deployment process.

regionstring

The region where the deployment is running.