Skip to main content
POST
/
v1
/
agent-deployments
Create an agent deployment
import requests

url = "https://api.13-215-85-171.sslip.io/v1/agent-deployments"

payload = { "name": "<string>" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "id": "adpl_1234abcd",
  "name": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "active_version_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Headers

​
Idempotency-Key
string
required

Reuse the same key to safely retry the same create, reusable snapshot create, fork, upload create/complete, or agent deployment create operation without duplicating work.

Body

application/json
​
name
string
required
Required string length: 1 - 128
​
mode
enum<string>
required
Available options:
job,
service
​
description
string | null
​
metadata
object

Free-form user-supplied metadata; stored verbatim as arbitrary JSON and never interpreted by the server, so the shape is deliberately open.

Response

Agent deployment created

​
id
string
required
Example:

"adpl_1234abcd"

​
name
string
required
​
mode
enum<string>
required
Available options:
job,
service
​
status
enum<string>
required
Available options:
active,
paused,
deleted
​
metadata
object
required

Free-form user-supplied metadata; stored verbatim as arbitrary JSON and never interpreted by the server, so the shape is deliberately open.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
active_version_id
string | null
​
deleted_at
string<date-time> | null