Skip to main content
POST
/
agents
/
{agent_id}
/
deployments
Create Deployment
curl --request POST \
  --url https://api.example.com/agents/{agent_id}/deployments \
  --header 'Content-Type: application/json' \
  --data '
{
  "docker_image": "<string>",
  "registration_metadata": {},
  "sgp_deploy_id": "<string>",
  "helm_release_name": "<string>"
}
'
{
  "id": "<string>",
  "agent_id": "<string>",
  "docker_image": "<string>",
  "is_production": true,
  "registration_metadata": {},
  "acp_url": "<string>",
  "sgp_deploy_id": "<string>",
  "helm_release_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "promoted_at": "2023-11-07T05:31:56Z",
  "expires_at": "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.

Path Parameters

​
agent_id
string
required

Body

application/json
​
docker_image
string
required

Full Docker image URI.

​
registration_metadata
Registration Metadata · object

Git/build metadata (commit_hash, branch_name, author_name, author_email, build_timestamp).

​
sgp_deploy_id
string | null

SGP deployment ID.

​
helm_release_name
string | null

Helm release name.

Response

Successful Response

​
id
string
required

The unique identifier of the deployment.

​
agent_id
string
required

The agent this deployment belongs to.

​
docker_image
string
required

Full Docker image URI.

​
status
enum<string>
required

Current deployment status.

Available options:
Pending,
Ready,
Failed
​
is_production
boolean
required

Whether this is the production deployment.

​
registration_metadata
Registration Metadata · object

Git/build metadata from the agent pod.

​
acp_url
string | null

ACP URL set when agent registers.

​
sgp_deploy_id
string | null

Correlates to SGP's agentex_deploys.id.

​
helm_release_name
string | null

Helm release name for cleanup.

​
created_at
string<date-time> | null

When the deployment was created.

​
promoted_at
string<date-time> | null

When promoted to production.

​
expires_at
string<date-time> | null

When marked for cleanup.