# Create pause

URL: https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-pause

> Asks a running session to pause.

`POST /v1/agent/sessions/{id}/pause`

> [Agent →](https://docs.hanzo.ai/docs/openapi/agent) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                     |
| ------------- | --------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/agent/sessions/{id}/pause` |
| **Method**    | `POST`                                              |
| **Operation** | `post_agent_sessions_by_id_pause`                   |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`              |

Asks a running session to pause. Recorded durably, and forwarded
to the durable-execution engine when the session is task-backed.

A chat turn's run is paused where it runs: it stops, the session stays live as
`paused`, and its sandbox is PARKED — the pod stops and every file stays, with
nothing billed for compute — until a resume picks it up.

## Request

4 fields, body `application/json` (required).

| Field     | In   | Type   | Required | Description                                                                                                                                                                       |
| --------- | ---- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`      | path | string | yes      | ID is the session to steer, from the path.                                                                                                                                        |
| `id`      | body | string | —        | ID is the session to steer, from the path.                                                                                                                                        |
| `message` | body | string | —        | Message is free text for the running agent, up to 16 KiB.                                                                                                                         |
| `payload` | body | any    | —        | Payload is a structured argument for the command: any valid JSON up to 64 KiB, scanned for credentials before it is stored (a hit refuses the command with 422 and the findings). |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | agent.controlResult | ok      |
| `default` | problem-details     | refused |

`200` body — 11 fields.

| Field             | In   | Type            | Always | Description                                                                                                                                                                                  |
| ----------------- | ---- | --------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command`         | body | string          | —      | Command is the verb that was recorded: pause, resume, stop or message.                                                                                                                       |
| `event`           | body | agent.eventView | —      |                                                                                                                                                                                              |
| `event.actor`     | body | string          | —      | Actor is who produced the turn.                                                                                                                                                              |
| `event.createdAt` | body | string          | —      | CreatedAt is when the turn was recorded, RFC 3339 in UTC to the second.                                                                                                                      |
| `event.id`        | body | string          | —      | ID is the event's own handle, minted as "evt\_" + 32 hex characters.                                                                                                                         |
| `event.kind`      | body | string          | —      | Kind is what the turn IS, from a closed six: message (a model turn), tool-call, spawn (a subagent started), log, status, control (a steering command the running surface consumes).          |
| `event.payload`   | body | any             | —      | Payload is the turn's body, embedded as JSON rather than as a string — whatever the writer sent, up to 64 KiB, checked for well-formedness and scanned for credentials before it was stored. |
| `event.seq`       | body | integer (int64) | —      | Seq is the turn's position in this session's log: monotonic from 1, assigned by the store inside the insert, and unique PER SESSION rather than globally.                                    |
| `event.sessionId` | body | string          | —      | SessionID is the session this turn belongs to.                                                                                                                                               |
| `forwarded`       | body | boolean         | —      | Forwarded is whether the command also reached the durable-execution engine.                                                                                                                  |
| `run`             | body | string          | —      | Run is the run a resume started, under the same session.                                                                                                                                     |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo agent sessions pause <id>
```

**SDK**

**.ts**

```ts
import { Configuration, AgentApi } from 'hanzoai';

const api = new AgentApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAgentSessionsByIdPause({ id: 'id', id: "<id>", message: "<message>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AgentApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AgentApi(client).post_agent_sessions_by_id_pause(id='id', id="<id>", message="<message>")
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AgentAPI.PostAgentSessionsByIdPause(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, agent_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = agent_api::post_agent_sessions_by_id_pause(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AgentApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AgentApi(client).postAgentSessionsByIdPause();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/agent/sessions/<id>/pause \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "message": "<message>"
     }'
```

**MCP**

MCP reaches **agent** through the `agent` tool, which names its 38 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_agents"
         }
       }
     }'
```

---

[Agent API](https://docs.hanzo.ai/docs/openapi/agent) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
