API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deploy

Deploy a built agent image

POST/v5/agentex/deployments

Get an agent deployment

GET/v5/agentex/deployments/{deployment_id}

List agent deployments

GET/v5/agentex/deployments

Get agent deployment logs

GET/v5/agentex/deployments/{deployment_id}/logs

Delete and tear down a deployment

DELETE/v5/agentex/deployments/{deployment_id}

ModelsExpand Collapse

AgentexCloudDeploy object { id, account_id, created_at, 11 more }

id: string

The unique identifier of the deployment.

account_id: string

The ID of the account that owns the given entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

environment_config: string

YAML content of environment configuration from the environment config file.

manifest_file: string

YAML content of manifest configuration.

namespace: string

Kubernetes namespace where the deployment is deployed.

status: string

Deployment status: pending, running, completed, failed, or cancelled.

build_id: optional string

The build_id of the cloud build that produced the deployed image.

deploy_events: optional array of AgentexCloudDeployEvent { message, reason, timestamp, type }

Kubernetes events for this deployment.

message: optional string

Full event message.

reason: optional string

Short reason, e.g. ‘Pulling’, ‘Scheduled’.

timestamp: optional string

When the event was observed.

formatdate-time

type: optional string

Event type, e.g. ‘Normal’ or ‘Warning’.

expires_at: optional string

When this deployment will be cleaned up. Always set on preview deployments (defaults to 8 hours from creation if the request omits it). Null on non-preview deployments — they have no TTL.

formatdate-time

helm_release_name: optional string

Helm release name after successful deployment.

object: optional "agentex_cloud_deploy"

preview_label: optional string

Non-unique grouping label for preview deployments. Filter ?preview_label=X&limit=1 returns the latest deploy for the label. Sanitized (lowercase alphanumeric + hyphens) and capped at 30 characters.

AgentexCloudDeployEvent object { message, reason, timestamp, type }

Slim event representation for the API response.

message: optional string

Full event message.

reason: optional string

Short reason, e.g. ‘Pulling’, ‘Scheduled’.

timestamp: optional string

When the event was observed.

formatdate-time

type: optional string

Event type, e.g. ‘Normal’ or ‘Warning’.

DeployLogsResponse object { deployment_id, has_more, lines, next_cursor }

Response containing structured deployment log lines with cursor-based pagination.

The CLI can poll this endpoint to stream logs incrementally:

1. First call: no after_id
2. Subsequent calls: after_id=next_cursor from previous response
3. Stop polling when has_more is False and the deployment reaches a terminal status

deployment_id: string

The deployment ID

has_more: boolean

True if there may be more lines beyond this page (len(lines) == limit).

lines: optional array of object { id, message, log_level, timestamp }

Structured log lines

id: string

Unique log line identifier (time-ordered)

message: string

Log line content after the K8s timestamp

log_level: optional string

Parsed log level (INFO, ERROR, WARN, DEBUG, FATAL)

timestamp: optional string

Parsed K8s log timestamp

formatdate-time

next_cursor: optional string

Cursor for the next page. Pass this as the after_id query parameter to get subsequent logs.