Documentation

Deploy

deploy

Methods

Create Deployment -> { id, account_id, created_at, 7 more... }
post/v5/agentex/deployments

Create a new deployment.

Submits a deployment request. The deployment will:

  1. Parse and merge configuration files
  2. Create a Kubernetes Job running helm install
  3. Wait for deployment completion
  4. Return results
Get Deployment -> { id, account_id, created_at, 7 more... }
get/v5/agentex/deployments/{deployment_id}

Get a deployment by its ID.

List Deployments -> CursorPage<{ id, account_id, created_at, 7 more... }>
get/v5/agentex/deployments

List all deployments with pagination.

query Parameters
ending_before: string
Optional
limit: number
Optional
(maximum: 10000, minimum: 1, default: 100)
sort_by: string
Optional
sort_order:
Optional
(default: "asc")
"asc"
"desc"
starting_after: string
Optional
Response fields
has_more: boolean

Whether there are more items left to be fetched.

items: Array<{ id, account_id, created_at, 7 more... }>
total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number
Optional
(default: 100)

The maximum number of items to return.

object: "list"
Optional
(default: "list")
Request example
200Example
Get Deployment Logs -> { deployment_id, has_more, lines, 1 more... }
get/v5/agentex/deployments/{deployment_id}/logs

Get structured log lines for a deployment with cursor-based pagination.

The CLI can poll this endpoint to stream logs incrementally:

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

Domain types

DeployCreateResponse = { id, account_id, created_at, 7 more... }
DeployListResponse = { id, account_id, created_at, 7 more... }
DeployLogsResponse = { deployment_id, has_more, lines, 1 more... }

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
DeployRetrieveResponse = { id, account_id, created_at, 7 more... }