---
# @generated by sylphx-gen. Do not edit.
title: "Cancel a queued execution"
description: "`agents.queued_executions.cancel` (POST /v1/{name}:cancel): Cancels only a queued future execution; an already admitted turn retains its receipt."
type: reference
product: agents
summary: "Cancels only a queued future execution; an already admitted turn retains its receipt."
updated: 2026-09-28
nav: false
---

Cancels only a queued future execution; an already admitted turn retains its receipt.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/queued_executions/turn:cancel`
- **Scope** `agents:sessions`
- **Effect** `write` — a successful call changes state.
- **Collection** [queued_executions](/docs/api/queued_executions)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Exact reserved execution name. Required. |
| `operation_id` | `string` | Permanent caller mutation identity, at most 128 bytes. Required. |
| `expected_generation` | `int64` | The exact authority generation to cancel, never a newest-row selector. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Exact Session and reserved public turn number. |
| `uid` | `string` | Immutable platform Resource UID. Output only. |
| `meta` | `ResourceMeta` | Standard metadata. Output only. |
| `turn` | `int64` | Exact future turn; never selected by a model or a Task. Output only. |
| `state` | `string` | queued, consumed, superseded or cancelled. Queued does not run inference. Output only. |
| `goal` | `string` | Optional exact Goal whose objective and budget this authority covers. Output only. |
| `expire_time` | `timestamp` | Earliest captured handle expiry; ordinary admission revalidates all grants. Output only. |
| `create_time` | `timestamp` | When the caller reserved this execution. Output only. |
| `update_time` | `timestamp` | When the state last changed. Output only. |
| `generation` | `int64` | Configuration generation, advanced only by explicit replacement. Output only. |
| `automatic` | `bool` | Whether the caller explicitly authorized automatic wait readmission. Output only. |
| `continuation_state` | `string` | disabled, unscheduled, pending, waiting or finished; no inference implied. Output only. |
| `blocked_reason` | `string` | Current delivery/authority/owner hold, when automatic continuation is blocked. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/queued_executions/turn:cancel" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expected_generation":1,"operation_id":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.agents.queuedExecutions.cancel({ expectedGeneration: 1, name: 'orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/queued_executions/turn', operationId: '…' })
```

**Rust**

```rust
let mut req = sylphx::agents::CancelQueuedSessionExecutionRequest::default();
req.expected_generation = 1;
req.name = "orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/queued_executions/turn".to_string();
req.operation_id = "…".to_string();
let response = sx.agents().queued_executions().cancel(req).await?;
```

**CLI**

```bash
sylphx agents queued-executions cancel orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/queued_executions/turn
```

**MCP**

```json
{ "method_id": "agents.queued_executions.cancel", "args": {"expected_generation":1,"name":"orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/queued_executions/turn","operation_id":"…"} }
```