> ## Documentation Index
> Fetch the complete documentation index at: https://docs.archetypeai.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Start with /introduction/getting-started. Use the Inference API's Direct Query endpoint (POST /api/inference/query) with the newton-c-2.6 or newton-fusion-1.0 model (text, image, and video reasoning) or the omega-embedding encoder (time-series embeddings). ATAI_API_ENDPOINT is the base URL https://platform.u1.archetypeai.app with no version path; every endpoint path begins with /api. Pages whose descriptions are marked (Archived) document the legacy Lens runtime — do not use them for new projects.

# List Deployments

> Page through your organization's deployments, filtered by project, package or status

Requires [version 2.0.1](https://docs.archetypeai.app/release-notes/2.0.x.md#v2-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 with `project_id`, to one package with `package_id`, and to
one `status`.

## Request

**limit** `integer` (default: 100)

Page size. Minimum `1`, maximum `1000`.

**after** `string`

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

**before** `string`

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

**project\_id** `string`

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

**package\_id** `string`

Only the deployments of this package (`pkg_` id).

**status** `string`

Only deployments in this status: `deploying`, `ready`, `stopped`, or `failed`.

**include\_total** `boolean` (default: false)

When `true`, the response includes `total`. Off by default because it costs an extra count per
request. [v2.0.1+](https://docs.archetypeai.app/release-notes/2.0.x.md#v2-0-1)

## Response

**data** `array` *required*

The page, newest first in both cursor directions. Each entry is a deployment, with the same
fields as [Get Deployment](https://docs.archetypeai.app/api-reference/agents/deployments/get-deployment.md) returns.

**has\_more** `boolean` *required*

True when more results exist beyond this page in the direction of travel.

**next\_cursor** `string`

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.

**prev\_cursor** `string`

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.

**total** `integer`

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+](https://docs.archetypeai.app/release-notes/2.0.x.md#v2-0-1)

```bash cURL theme={"system"}
curl "$ATAI_API_ENDPOINT/agents/deployments?limit=20" \
  -H "Authorization: Bearer $ATAI_API_KEY"
```

```bash cURL - Deployments of a Package theme={"system"}
curl "$ATAI_API_ENDPOINT/agents/deployments?package_id=pkg_01jcb2x7m4qv8n3h5t6rk9dzs0" \
  -H "Authorization: Bearer $ATAI_API_KEY"
```

```python Python theme={"system"}
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']}")
```

```javascript JavaScript theme={"system"}
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);
}
```

```json 200 - Page of deployments theme={"system"}
{
  "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

> [!NOTE]
>
> * Passing both `after` and `before` returns `400`, as does a malformed cursor, `project_id`, `package_id`, or `status`.
> * A `project_id` that does not exist or that you cannot see returns `404`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.