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

# Stop Deployment

> Stop a deployment and cancel the sessions still running on it

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 stops a deployment and returns it. The deployment becomes `stopped`, and
every session on it that has not ended becomes `cancelled`, its run stopped. No session can be
opened on a stopped deployment.

You can stop a deployment that is `deploying` or `ready`. Stopping is final: to run the package
again, deploy it again. Once it is stopped, you can [delete
it](https://docs.archetypeai.app/api-reference/agents/deployments/delete-deployment.md) after deleting its sessions.

## Request

**deployment\_id** `string` *required*

Deployment `dpl_` id.

## Response

Returns `200 OK` with the stopped deployment, with the same fields as [Get
Deployment](https://docs.archetypeai.app/api-reference/agents/deployments/get-deployment.md) returns. Its `status` is `stopped`
and `stopped_at` is set.

```bash cURL theme={"system"}
curl -X POST "$ATAI_API_ENDPOINT/agents/deployments/dpl_01jcf3n8q5vx2mt7r4k6hbzd9a/stop" \
  -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.post(
    f"{base_url}/agents/deployments/dpl_01jcf3n8q5vx2mt7r4k6hbzd9a/stop",
    headers={"Authorization": f"Bearer {api_key}"},
)

if response.status_code == 200:
    print(response.json()["status"])
else:
    print(f"Error: {response.json()['errors']}")
```

```javascript JavaScript theme={"system"}
const response = await fetch(
  `${process.env.ATAI_API_ENDPOINT}/agents/deployments/dpl_01jcf3n8q5vx2mt7r4k6hbzd9a/stop`,
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
    }
  }
);

const body = await response.json();

if (response.ok) {
  console.log(body.status);
} else {
  console.error('Error:', body.errors);
}
```

```json 200 - Deployment stopped theme={"system"}
{
  "id": "dpl_01jcf3n8q5vx2mt7r4k6hbzd9a",
  "org_id": "org_01jc8m5r2vq9xt4bn7h3kdzs6w",
  "project_id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
  "created_by": "usr_01jc8m6t3wr0yv5cp8j4mezt7x",
  "package_id": "pkg_01jcb2x7m4qv8n3h5t6rk9dzs0",
  "kind": "batch",
  "status": "stopped",
  "error": null,
  "created_at": "2026-10-29T16:00:00Z",
  "ready_at": "2026-10-29T16:00:00Z",
  "stopped_at": "2026-10-29T18:30:00Z",
  "sessions": null
}
```

## Important Notes

> [!NOTE]
>
> * A `409` means the deployment has already ended as `stopped` or `failed`.
> * A `403` means you can see the deployment's project but cannot modify it.
> * A `404` means the deployment does not exist, belongs to another organization, or is in a project you cannot see.
> * Stopping cancels the deployment's `pending` and `running` sessions. Each one records a `cancelled: its deployment was stopped` event in [List Session Events](https://docs.archetypeai.app/api-reference/agents/sessions/list-session-events.md).


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