Skip to main content
POST
Deploy a built agent image

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Body

application/json
manifest_file
string
required

YAML content of manifest configuration.

environment_config
string
required

YAML content of environment configuration from the environment config file.

build_id
string

The build_id of the cloud build. Required if image_name and image_tag are not provided.

image_name
string

Name of the image to deploy. Required if build_id is not provided.

image_tag
string

Tag of the image to deploy. Required if build_id is not provided.

preview
boolean
default:false

When True, creates a preview deployment with a unique deployment-id suffix appended to the helm release name.

preview_label
string

Non-unique grouping label for the preview (e.g. branch name, PR number). Persisted on the deployment record so callers can list all deploys for a given label via GET /v5/agentex/deployments?preview_label=X&limit=1 (get the latest). Sanitized to lowercase alphanumeric + hyphens for K8s DNS-label compatibility (max 30 characters after sanitization). Each deploy still gets a unique helm release name regardless of label, so concurrent redeploys never share K8s resources. Only valid when preview=True.

expires_at
string<date-time>

ISO 8601 expiry timestamp. Only valid for preview deployments. If omitted on a preview deployment, defaults to 8 hours from now. Previews are always ephemeral and always have an expires_at.

Response

Successful Response

id
string
required

The unique identifier of the deployment.

namespace
string
required

Kubernetes namespace where the deployment is deployed.

manifest_file
string
required

YAML content of manifest configuration.

environment_config
string
required

YAML content of environment configuration from the environment config file.

status
string
required

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

account_id
string
required

The ID of the account that owns the given entity.

created_at
string<date-time>
required

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

created_by
Identity · object
required

The identity that created the entity.

object
string
default:agentex_cloud_deploy
Allowed value: "agentex_cloud_deploy"
build_id
string

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

helm_release_name
string

Helm release name after successful deployment.

expires_at
string<date-time>

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.

preview_label
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.

deploy_events
AgentexCloudDeployEvent · object[]

Kubernetes events for this deployment.