Skip to main content
The status endpoints let you track the lifecycle of operations created via /api/v1/do.
  • GET /api/v1/status/:mainTaskId
  • GET /api/v1/status/:mainTaskId/:fileKey
These routes are backed by the OperationStatusFileData, and OperationStatusResponse types.

Status schema

Get main task status

Response (completed):
Response (failed):

Get specific file task status

When fileKey is present, the response narrows to the matching file task (if found).

Polling vs. webhooks

  • Polling – use the status endpoints from your backend or via the official SDK (see SDKs → Node).
  • Webhooks – for production workloads, configure webhooks to receive operation.completed, operation.failed, fileTask.completed, and fileTask.failed events instead of (or in addition to) polling.

Polling example

See Business API → Webhooks for event payload shapes.