Get async task status
Utilities
Get task status
Poll the task status endpoint to check the progress of asynchronous requests, retrieve results, and handle task completion for background API jobs.
GET
Get async task status
Overview
You can poll this endpoint to check the status of an asynchronous task. Thestatus field can have one of the following values:
QUEUED: The task has been received and is waiting to be processed.PROCESSING: The task is actively being processed.COMPLETED: The task has finished successfully. Theresponseobject will contain the full result.FAILED: The task failed to complete. Theresponseobject may contain error details.
QUEUED or PROCESSING state, the response will only contain the current status. Once the task is COMPLETED or FAILED, the response will include a response object containing the full result.
Task retention policy
COMPLETED and FAILED tasks are stored in our system for 24 hours after completion. During this time, you can retrieve the full results using the task ID. After 24 hours, the task record and its associated response data are permanently deleted from our system. HTML URLs included in responses expire after 24 hours from generation, regardless of the task’s retention status.Example usage
Check a pending task
Fetch a completed task
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the task to fetch.
Response
Successful response with the task status and result if completed.