Notion: Retrieve an async task
Notion asyncTasks.retrieveAsyncTask: arguments, response, policy and SDK examples.
← Async tasks operations · Get started
Operation notion.retrieve_async_task
Provider route: GET /v1/async_tasks/{task_id}. 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["asyncTasks"]["retrieveAsyncTask"]>[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.asyncTasks.retrieveAsyncTask(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.async_tasks.retrieve_async_task(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.task_id | string | Required within parent | The ID of the async task to retrieve. Minimum length: 1 |
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 |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve an async task — response body — object async_task, status: queued, running, retrying |
$ (anyOf 2) | object | Alternative | Additional keys: allowed |
$ (anyOf 2).created_time | string | Required within parent | Format: date-time |
$ (anyOf 2).id | string | Required within parent | Minimum length: 1 |
$ (anyOf 2).object | string | Required within parent | Must equal: async_task |
$ (anyOf 2).operation | object | Required within parent | Additional keys: allowed |
$ (anyOf 2).operation.name | string | Required within parent | Minimum length: 1 |
$ (anyOf 2).operation.surface | string | Required within parent | Known values: rest, mcp |
$ (anyOf 2).result | object | Required within parent | Additional keys: see wildcard field |
$ (anyOf 2).result.* | Model | Additional keys | Expand Retrieve an async task — response body — object async task, status succeeded result value |
$ (anyOf 2).status | string | Required within parent | Must equal: succeeded |
$ (anyOf 2).status_url | string | Required within parent | Minimum length: 1 |
$ (anyOf 3) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).created_time | string | Required within parent | Format: date-time |
$ (anyOf 3).error | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 1) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 1).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 1).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 1).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 1).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 1).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 1).code | string | Required within parent | Must equal: invalid_json |
$ (anyOf 3).error (anyOf 1).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 1).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 1).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 1).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 1).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 2) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 2).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 2).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 2).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 2).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 2).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 2).code | string | Required within parent | Must equal: invalid_request_url |
$ (anyOf 3).error (anyOf 2).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 2).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 2).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 2).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 2).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 3) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 3).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 3).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 3).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 3).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 3).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 3).code | string | Required within parent | Must equal: invalid_request |
$ (anyOf 3).error (anyOf 3).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 3).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 3).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 3).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 3).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 4) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 4).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 4).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 4).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 4).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 4).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 4).code | string | Required within parent | Must equal: missing_version |
$ (anyOf 3).error (anyOf 4).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 4).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 4).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 4).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 4).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 5) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 5).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 5).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 5).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 5).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 5).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 5).code | string | Required within parent | Must equal: invalid_beta |
$ (anyOf 3).error (anyOf 5).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 5).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 5).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 5).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 5).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 6) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 6).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 6).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 6).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 6).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 6).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 6).code | string | Required within parent | Must equal: validation_error |
$ (anyOf 3).error (anyOf 6).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 6).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 6).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 6).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 6).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 7) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 7).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 7).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 7).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 7).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 7).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 7).code | string | Required within parent | Must equal: unauthorized |
$ (anyOf 3).error (anyOf 7).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 7).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 7).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 7).status (anyOf 1) | integer | Alternative | Must equal: 401 |
$ (anyOf 3).error (anyOf 7).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 8) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 8).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 8).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 8).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 8).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 8).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 8).code | string | Required within parent | Must equal: restricted_resource |
$ (anyOf 3).error (anyOf 8).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 8).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 8).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 8).status (anyOf 1) | integer | Alternative | Must equal: 403 |
$ (anyOf 3).error (anyOf 8).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 9) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 9).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 9).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 9).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 9).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 9).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 9).code | string | Required within parent | Must equal: object_not_found |
$ (anyOf 3).error (anyOf 9).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 9).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 9).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 9).status (anyOf 1) | integer | Alternative | Must equal: 404 |
$ (anyOf 3).error (anyOf 9).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 10) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 10).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 10).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 10).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 10).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 10).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 10).code | string | Required within parent | Must equal: directory_not_found |
$ (anyOf 3).error (anyOf 10).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 10).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 10).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 10).status (anyOf 1) | integer | Alternative | Must equal: 404 |
$ (anyOf 3).error (anyOf 10).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 11) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 11).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 11).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 11).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 11).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 11).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 11).code | string | Required within parent | Must equal: rate_limited |
$ (anyOf 3).error (anyOf 11).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 11).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 11).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 11).status (anyOf 1) | integer | Alternative | Must equal: 429 |
$ (anyOf 3).error (anyOf 11).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 12) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 12).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 12).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 12).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 12).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 12).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 12).code | string | Required within parent | Must equal: service_overload |
$ (anyOf 3).error (anyOf 12).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 12).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 12).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 12).status (anyOf 1) | integer | Alternative | Must equal: 529 |
$ (anyOf 3).error (anyOf 12).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 13) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 13).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 13).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 13).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 13).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 13).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 13).code | string | Required within parent | Must equal: internal_server_error |
$ (anyOf 3).error (anyOf 13).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 13).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 13).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 13).status (anyOf 1) | integer | Alternative | Must equal: 500 |
$ (anyOf 3).error (anyOf 13).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 14) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 14).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 14).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 14).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 14).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 14).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 14).code | string | Required within parent | Must equal: service_unavailable |
$ (anyOf 3).error (anyOf 14).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 14).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 14).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 14).status (anyOf 1) | integer | Alternative | Must equal: 503 |
$ (anyOf 3).error (anyOf 14).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 15) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 15).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 15).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 15).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 15).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 15).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 15).code | string | Required within parent | Must equal: gateway_timeout |
$ (anyOf 3).error (anyOf 15).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 15).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 15).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 15).status (anyOf 1) | integer | Alternative | Must equal: 504 |
$ (anyOf 3).error (anyOf 15).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 16) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 16).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 16).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 16).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 16).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 16).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 16).code | string | Required within parent | Must equal: conflict_error |
$ (anyOf 3).error (anyOf 16).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 16).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 16).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 16).status (anyOf 1) | integer | Alternative | Must equal: 409 |
$ (anyOf 3).error (anyOf 16).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 17) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 17).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 17).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 17).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 17).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 17).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 17).code | string | Required within parent | Must equal: idempotency_key_reused |
$ (anyOf 3).error (anyOf 17).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 17).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 17).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 17).status (anyOf 1) | integer | Alternative | Must equal: 409 |
$ (anyOf 3).error (anyOf 17).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 18) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 18).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 18).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 18).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 18).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 18).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 18).code | string | Required within parent | Must equal: row_limit_exceeded |
$ (anyOf 3).error (anyOf 18).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 18).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 18).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 18).status (anyOf 1) | integer | Alternative | Must equal: 406 |
$ (anyOf 3).error (anyOf 18).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 19) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 19).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 19).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 19).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 19).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 19).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 19).code | string | Required within parent | Must equal: status_change_not_allowed |
$ (anyOf 3).error (anyOf 19).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 19).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 19).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 19).status (anyOf 1) | integer | Alternative | Must equal: 403 |
$ (anyOf 3).error (anyOf 19).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 20) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 20).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 20).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 20).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 20).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 20).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 20).code | string | Required within parent | Must equal: agent_deleted |
$ (anyOf 3).error (anyOf 20).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 20).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 20).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 20).status (anyOf 1) | integer | Alternative | Must equal: 409 |
$ (anyOf 3).error (anyOf 20).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 21) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 21).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 21).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 21).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 21).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 21).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 21).code | string | Required within parent | Must equal: invalid_credit_limit |
$ (anyOf 3).error (anyOf 21).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 21).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 21).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 21).status (anyOf 1) | integer | Alternative | Must equal: 400 |
$ (anyOf 3).error (anyOf 21).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 22) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 22).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 22).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 22).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 22).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 22).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 22).code | string | Required within parent | Must equal: workspace_credits_exhausted |
$ (anyOf 3).error (anyOf 22).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 22).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 22).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 22).status (anyOf 1) | integer | Alternative | Must equal: 403 |
$ (anyOf 3).error (anyOf 22).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).error (anyOf 23) | object | Alternative | Additional keys: allowed |
$ (anyOf 3).error (anyOf 23).additional_data | object | Optional | Additional keys: see wildcard field |
$ (anyOf 3).error (anyOf 23).additional_data.* | JSON | Additional keys | |
$ (anyOf 3).error (anyOf 23).additional_data.* (anyOf 1) | string | Alternative | |
$ (anyOf 3).error (anyOf 23).additional_data.* (anyOf 2) | array | Alternative | |
$ (anyOf 3).error (anyOf 23).additional_data.* (anyOf 2)[] | string | Each item | |
$ (anyOf 3).error (anyOf 23).code | string | Required within parent | Must equal: agent_credit_limit_reached |
$ (anyOf 3).error (anyOf 23).message | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).error (anyOf 23).object | string | Required within parent | Must equal: error |
$ (anyOf 3).error (anyOf 23).status | JSON | Required within parent | |
$ (anyOf 3).error (anyOf 23).status (anyOf 1) | integer | Alternative | Must equal: 403 |
$ (anyOf 3).error (anyOf 23).status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).id | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).object | string | Required within parent | Must equal: async_task |
$ (anyOf 3).operation | object | Required within parent | Additional keys: allowed |
$ (anyOf 3).operation.name | string | Required within parent | Minimum length: 1 |
$ (anyOf 3).operation.surface | string | Required within parent | Known values: rest, mcp |
$ (anyOf 3).status | string | Required within parent | Must equal: failed |
$ (anyOf 3).status_url | string | Required within parent | Minimum length: 1 |
Referenced models: Retrieve an async task — response body — object async task, status succeeded result value, Retrieve an async task — response body — object async_task, status: queued, running, retrying
Schemas
Section titled “Schemas”Retrieve an async task — response body — object async task, status succeeded result value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative | |
$ (anyOf 4) | null | Alternative | |
$ (anyOf 5) | array | Alternative | |
$ (anyOf 5)[] | Model | Each item | Expand Retrieve an async task — response body — object async task, status succeeded result value |
$ (anyOf 6) | object | Alternative | Additional keys: see wildcard field |
$ (anyOf 6).* | Model | Additional keys | Expand Retrieve an async task — response body — object async task, status succeeded result value |
Referenced models: Retrieve an async task — response body — object async task, status succeeded result value
Retrieve an async task — response body — object async_task, status: queued, running, retrying
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
created_time | string | Required within parent | Format: date-time |
id | string | Required within parent | Minimum length: 1 |
object | string | Required within parent | Must equal: async_task |
operation | object | Required within parent | Additional keys: allowed |
operation.name | string | Required within parent | Minimum length: 1 |
operation.surface | string | Required within parent | Known values: rest, mcp |
poll_after_seconds | JSON | Required within parent | |
poll_after_seconds (anyOf 1) | integer | Alternative | Minimum: 0 |
poll_after_seconds (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Required within parent | Known values: queued, running, retrying |
status_url | string | Required within parent | Minimum length: 1 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: notion.retrieve_async_task. Catalog operation: retrieve_async_task. 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"}