curl "$ATAI_API_ENDPOINT/agents/deployments?limit=20" \
-H "Authorization: Bearer $ATAI_API_KEY"
curl "$ATAI_API_ENDPOINT/agents/deployments?package_id=pkg_01jcb2x7m4qv8n3h5t6rk9dzs0" \
-H "Authorization: Bearer $ATAI_API_KEY"
import os
import requests
base_url = os.environ["ATAI_API_ENDPOINT"]
api_key = os.environ["ATAI_API_KEY"]
response = requests.get(
f"{base_url}/agents/deployments",
headers={"Authorization": f"Bearer {api_key}"},
params={"limit": 20, "status": "ready"},
)
if response.status_code == 200:
page = response.json()
for deployment in page["data"]:
print(deployment["id"], deployment["kind"], deployment["status"])
else:
print(f"Error: {response.json()['errors']}")
const response = await fetch(
`${process.env.ATAI_API_ENDPOINT}/agents/deployments?limit=20&status=ready`,
{
headers: {
'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
}
}
);
const body = await response.json();
if (response.ok) {
body.data.forEach((deployment) => console.log(deployment.id, deployment.status));
} else {
console.error('Error:', body.errors);
}
{
"data": [
{
"id": "dpl_01jcf3n8q5vx2mt7r4k6hbzd9a",
"org_id": "org_01jc8m5r2vq9xt4bn7h3kdzs6w",
"project_id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
"created_by": "usr_01jc8m6t3wr0yv5cp8j4mezt7x",
"package_id": "pkg_01jcb2x7m4qv8n3h5t6rk9dzs0",
"kind": "batch",
"status": "ready",
"error": null,
"created_at": "2026-10-29T16:00:00Z",
"ready_at": "2026-10-29T16:00:00Z",
"stopped_at": null,
"sessions": null
}
],
"has_more": false,
"next_cursor": null,
"prev_cursor": null
}
Deployments
List Deployments
Page through your organization’s deployments, filtered by project, package or status
GET
/
api
/
agents
/
deployments
curl "$ATAI_API_ENDPOINT/agents/deployments?limit=20" \
-H "Authorization: Bearer $ATAI_API_KEY"
curl "$ATAI_API_ENDPOINT/agents/deployments?package_id=pkg_01jcb2x7m4qv8n3h5t6rk9dzs0" \
-H "Authorization: Bearer $ATAI_API_KEY"
import os
import requests
base_url = os.environ["ATAI_API_ENDPOINT"]
api_key = os.environ["ATAI_API_KEY"]
response = requests.get(
f"{base_url}/agents/deployments",
headers={"Authorization": f"Bearer {api_key}"},
params={"limit": 20, "status": "ready"},
)
if response.status_code == 200:
page = response.json()
for deployment in page["data"]:
print(deployment["id"], deployment["kind"], deployment["status"])
else:
print(f"Error: {response.json()['errors']}")
const response = await fetch(
`${process.env.ATAI_API_ENDPOINT}/agents/deployments?limit=20&status=ready`,
{
headers: {
'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
}
}
);
const body = await response.json();
if (response.ok) {
body.data.forEach((deployment) => console.log(deployment.id, deployment.status));
} else {
console.error('Error:', body.errors);
}
{
"data": [
{
"id": "dpl_01jcf3n8q5vx2mt7r4k6hbzd9a",
"org_id": "org_01jc8m5r2vq9xt4bn7h3kdzs6w",
"project_id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
"created_by": "usr_01jc8m6t3wr0yv5cp8j4mezt7x",
"package_id": "pkg_01jcb2x7m4qv8n3h5t6rk9dzs0",
"kind": "batch",
"status": "ready",
"error": null,
"created_at": "2026-10-29T16:00:00Z",
"ready_at": "2026-10-29T16:00:00Z",
"stopped_at": null,
"sessions": null
}
],
"has_more": false,
"next_cursor": null,
"prev_cursor": null
}
Requires version 2.0.1 or later of the Archetype platform.
Overview
This endpoint returns a cursor-paginated page of the deployments of every project you can see, newest first. Narrow it to one project withproject_id, to one package with package_id, and to
one status.
Request
Forward cursor: return the deployments created before it. Pass the
next_cursor of the previous
page. The cursor is opaque: never build it from deployment fields. Mutually exclusive with
before.Backward cursor: return the deployments created after it. Pass the
prev_cursor of the current
page. The cursor is opaque: never build it from deployment fields. Mutually exclusive with
after.Filter by project. Omitted: the deployments of every project you can see. A project’s
prj_ id:
that project’s deployments only (404 when it does not exist or you cannot see it).When
true, the response includes total. Off by default because it costs an extra count per
request. v2.0.1+Response
The page, newest first in both cursor directions. Each entry is a deployment, with the same
fields as Get Deployment returns.
Cursor for the next page in the same direction. Pass it as
after when paging forward, or as
before when you supplied before. null when has_more is false.Cursor to step back the way this page was reached. Pass it as
before after paging forward, or
as after after paging backward. null on a request that carried no cursor.How many deployments match the request’s filters across all pages, ignoring
limit and the cursor.
Present only when you set include_total=true. v2.0.1+curl "$ATAI_API_ENDPOINT/agents/deployments?limit=20" \
-H "Authorization: Bearer $ATAI_API_KEY"
curl "$ATAI_API_ENDPOINT/agents/deployments?package_id=pkg_01jcb2x7m4qv8n3h5t6rk9dzs0" \
-H "Authorization: Bearer $ATAI_API_KEY"
import os
import requests
base_url = os.environ["ATAI_API_ENDPOINT"]
api_key = os.environ["ATAI_API_KEY"]
response = requests.get(
f"{base_url}/agents/deployments",
headers={"Authorization": f"Bearer {api_key}"},
params={"limit": 20, "status": "ready"},
)
if response.status_code == 200:
page = response.json()
for deployment in page["data"]:
print(deployment["id"], deployment["kind"], deployment["status"])
else:
print(f"Error: {response.json()['errors']}")
const response = await fetch(
`${process.env.ATAI_API_ENDPOINT}/agents/deployments?limit=20&status=ready`,
{
headers: {
'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
}
}
);
const body = await response.json();
if (response.ok) {
body.data.forEach((deployment) => console.log(deployment.id, deployment.status));
} else {
console.error('Error:', body.errors);
}
{
"data": [
{
"id": "dpl_01jcf3n8q5vx2mt7r4k6hbzd9a",
"org_id": "org_01jc8m5r2vq9xt4bn7h3kdzs6w",
"project_id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
"created_by": "usr_01jc8m6t3wr0yv5cp8j4mezt7x",
"package_id": "pkg_01jcb2x7m4qv8n3h5t6rk9dzs0",
"kind": "batch",
"status": "ready",
"error": null,
"created_at": "2026-10-29T16:00:00Z",
"ready_at": "2026-10-29T16:00:00Z",
"stopped_at": null,
"sessions": null
}
],
"has_more": false,
"next_cursor": null,
"prev_cursor": null
}
Important Notes
- Passing both
afterandbeforereturns400, as does a malformed cursor,project_id,package_id, orstatus. - A
project_idthat does not exist or that you cannot see returns404.
Was this page helpful?