TypeScript SDK
Async tasks
Retrieve an async task
Retrieve the status and result of an async task.
GET
TypeScript SDK
Use this endpoint to poll an
Set
Use
For non-terminal statuses (
A successful task includes the operation result:
A failed task includes a standard Public API error object:
async_task returned by an operation that was accepted for background execution.
The first async-capable REST endpoints are:
| Operation | Async support |
|---|---|
POST /v1/pages | Supported only when the request includes the markdown body parameter. |
PATCH /v1/pages/:page_id/markdown | Supported for markdown update requests. |
allow_async: true on a supported operation to opt into an async_task response. When allow_async is omitted or false, the endpoint keeps its existing synchronous response shape. allow_async changes response behavior only; it does not change validation, permissions, or the operation being performed.
Async task completion is polling-first in this version. Webhook notifications and ETA estimates are not part of the async task contract.
Async task response
When an operation is accepted for background execution, the supported endpoint returns HTTP202 with an async_task object:
status_url, or call this endpoint with the returned id, to check completion.
Status values
| Status | Meaning |
|---|---|
queued | The task has been accepted and persisted, but processing has not started. |
running | A worker is processing the task. |
retrying | The task hit a retryable infrastructure or downstream-service failure and is scheduled to retry. |
succeeded | The task completed successfully. The response includes a result object. |
failed | The task failed terminally. The response includes an error object using the standard Public API error shape. |
queued, running, and retrying), wait at least poll_after_seconds before polling again.
Completed and failed task metadata is retained for a bounded period. After expiry, polling the task returns the standard not-found response, so store any final result data your application needs.
Polling responses
An in-progress task includes the latest non-terminal status and polling guidance:Errors
Returns a 404 HTTP response if the async task does not exist, has expired, or is not visible to the current connection. Returns a 429 HTTP response if polling exceeds request limits. Malformed requests can return a 400 HTTP response. Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The API version to use for this request. The latest version is 2026-03-11.
Available options:
2026-03-11 Path Parameters
The ID of the async task to retrieve.
Minimum string length:
1Example:
"task_abc123"
Response
- Option 1
- Option 2
- Option 3
Allowed value:
"async_task"Minimum string length:
1Minimum string length:
1Available options:
queued, running, retrying Required range:
x >= 0