Notion: Cancel a session
Notion sessions.cancelSession: arguments, response, policy and SDK examples.
← Sessions operations · Get started
Operation notion.cancel_session
Provider route: POST /v1/sessions/{session_id}/cancel. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/notion with npm, or alter-sdk-notion with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { NotionIntegration } from "@alter-ai/notion";
async function execute(input: Parameters<NotionIntegration["sessions"]["cancelSession"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new NotionIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.sessions.cancelSession(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_notion import NotionIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = NotionIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.sessions.cancel_session(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.session_id | string | Required within parent | The ID of the session to cancel. |
body | object | Required within parent | Additional keys: not allowed |
body.event_id | string | Optional | A session event identifying the turn to cancel. If omitted, cancels the current nonterminal turn. |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
agent_id | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
error | object | Optional | Additional keys: allowed |
error.code | string | Required within parent | |
error.message | string | Required within parent | |
error.retryable | boolean | Required within parent | |
id | string | Required within parent | |
object | string | Required within parent | Always `session` Must equal: session |
required_actions | array | Optional | Maximum items: 100 |
required_actions[] | object | Each item | Additional keys: allowed |
required_actions[].action_id | string | Required within parent | |
required_actions[].options | array | Required within parent | Maximum items: 100 |
required_actions[].options[] | object | Each item | Additional keys: allowed |
required_actions[].options[].id | string | Required within parent | One of: `approve`, `reject` Known values: approve, reject |
required_actions[].options[].label | string | Required within parent | |
required_actions[].title | string | Required within parent | |
status | string | Required within parent | One of: `queued`, `in_progress`, `requires_action`, `completed`, `failed`, `canceled`, `terminated` Known values: queued, in_progress, requires_action, completed, failed, canceled, terminated |
title | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: notion.cancel_session. Catalog operation: cancel_session. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"Notion-Version": "2026-03-11"}