Skip to main content
POST
/
v5
/
agentex
/
deployments
Create Deployment
curl --request POST \
  --url https://api.egp.scale.com/v5/agentex/deployments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "manifest_file": "<string>",
  "environment_config": "<string>",
  "build_id": "<string>",
  "image_name": "<string>",
  "image_tag": "<string>",
  "preview": false,
  "preview_label": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "namespace": "<string>",
  "manifest_file": "<string>",
  "environment_config": "<string>",
  "status": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "type": "user",
    "object": "identity"
  },
  "object": "agentex_cloud_deploy",
  "build_id": "<string>",
  "helm_release_name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "preview_label": "<string>",
  "deploy_events": [
    {
      "type": "<string>",
      "reason": "<string>",
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Body

application/json
​
manifest_file
string
required
​
environment_config
string
required
​
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
​
namespace
string
required
​
manifest_file
string
required
​
environment_config
string
required
​
status
string
required
​
account_id
string
required
​
created_at
string<date-time>
required
​
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
​
helm_release_name
string
​
expires_at
string<date-time>
​
preview_label
string
​
deploy_events
AgentexCloudDeployEvent · object[]

Kubernetes events for this deployment.