Skip to main content
GET
/
agents
/
deployments
/
{deployment_id}
Get Deployment
curl --request GET \
  --url https://api.cartesia.ai/agents/deployments/{deployment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>'
{
  "id": "<string>",
  "agent_id": "<string>",
  "status": "<string>",
  "is_pinned": true,
  "is_live": true,
  "env_var_collection_id": "<string>",
  "source_code_file_id": "<string>",
  "git_commit_hash": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "build_completed_at": "2023-11-07T05:31:56Z",
  "build_error": "<string>",
  "build_logs": "<string>",
  "build_started_at": "2023-11-07T05:31:56Z",
  "deployment_started_at": "2023-11-07T05:31:56Z",
  "deployment_completed_at": "2023-11-07T05:31:56Z",
  "deployment_error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Cartesia API key

Headers

​
Cartesia-Version
enum<string>
required

API version header. Must be set to the API version, e.g. '2024-06-10'.

Available options:
2024-06-10,
2024-11-13,
2025-04-16
Example:

"2025-04-16"

Path Parameters

​
deployment_id
string
required

The ID of the deployment.

Response

200 - application/json
​
id
string
required

The unique identifier for the deployment.

​
agent_id
string
required

The ID of the agent associated with this deployment.

​
status
string
required

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

​
is_pinned
boolean
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_live
boolean
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_id
string
required

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

​
source_code_file_id
string
required

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

​
git_commit_hash
string
required

The commit hash of the Git repository for this deployment.

​
created_at
string<date-time>
required

The UTC timestamp when the deployment was created.

​
updated_at
string<date-time>
required

The UTC timestamp when the deployment was last updated.

​
build_completed_at
string<date-time>
required

The UTC timestamp when the build was completed.

​
build_logs
string
required

Logs generated during the build process of the deployment.

​
build_started_at
string<date-time>
required

The UTC timestamp when the build process started.

​
deployment_started_at
string<date-time>
required

The UTC timestamp when the deployment process started.

​
deployment_completed_at
string<date-time>
required

The UTC timestamp when the deployment process was completed.

​
build_error
string | null

Any error that occurred during the build process.

​
deployment_error
string | null

Any error that occurred during the deployment process.