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

# Cancel Session

> Cancel a pending or running session and stop its work

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 cancels a session that is `pending` or `running`, stops its work, and returns the
session. The deployment and its other sessions are not affected.

For a `serving` session, the answer can take up to 15 seconds while its in-flight work winds down.
The cancel stands even if that cannot be confirmed. `cancelled` is a terminal status.

> [!NOTE]
>
> A cancelled session cannot be resumed or restarted. To run the same input again, open a new
> session with [Create Session](https://docs.archetypeai.app/api-reference/agents/sessions/create-session.md).

## Request

**session\_id** `string` *required*

Session `ses_` id.

## Response

Returns `200 OK` with the cancelled session, with the same fields as [Get
Session](https://docs.archetypeai.app/api-reference/agents/sessions/get-session.md) returns. Its `status` is `cancelled` and
`completed_at` is set.

```bash cURL theme={"system"}
curl -X POST "$ATAI_API_ENDPOINT/agents/sessions/ses_01jcf4p9r6wy3nv8s5m7jcae0b/cancel" \
  -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/sessions/ses_01jcf4p9r6wy3nv8s5m7jcae0b/cancel",
    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/sessions/ses_01jcf4p9r6wy3nv8s5m7jcae0b/cancel`,
  {
    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 - Session cancelled theme={"system"}
{
  "id": "ses_01jcf4p9r6wy3nv8s5m7jcae0b",
  "deployment_id": "dpl_01jcf3n8q5vx2mt7r4k6hbzd9a",
  "package_id": "pkg_01jcb2x7m4qv8n3h5t6rk9dzs0",
  "org_id": "org_01jc8m5r2vq9xt4bn7h3kdzs6w",
  "project_id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
  "created_by": "usr_01jc8m6t3wr0yv5cp8j4mezt7x",
  "kind": "batch",
  "status": "cancelled",
  "connectors": {
    "source": [{"type": "file", "id": "file_abc123", "format": "csv"}]
  },
  "job_id": "job_01jcf4q2s7xz4pw9t6n8kdbf1c",
  "error": null,
  "created_at": "2026-10-29T16:05:00Z",
  "started_at": "2026-10-29T16:05:02Z",
  "completed_at": "2026-10-29T16:07:15Z"
}
```

## Important Notes

> [!NOTE]
>
> * A `409` means the session has already ended as `completed`, `failed`, or `cancelled`.
> * A `403` means you can see the session's project but cannot modify it.
> * A `404` means the session does not exist, belongs to another organization, or is in a project you cannot see.
> * [Stopping a deployment](https://docs.archetypeai.app/api-reference/agents/deployments/stop-deployment.md) cancels every session on it that has not ended.


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