Skip to main content
GET
Get async task status
Poll this endpoint to check the status of an asynchronous task. While the task is QUEUED (received, waiting) or PROCESSING (actively running), the response carries only the current status. Once it is COMPLETED (finished successfully) or FAILED, the response also includes a response object with the full result or error details, plus a webhook object with the delivery status if you set a webhook.url.

Task retention policy

COMPLETED and FAILED tasks are permanently deleted, response data included, by an hourly cleanup once they are 24 hours old. Age counts from when you created the task, not from when it finished, so fetch results within 24 hours of submitting. HTML URLs included in responses expire 24 hours after generation, regardless of the task’s retention status.

Example usage

Check a pending task

Fetch a completed task

Authorizations

Authorization
string
header
required

cloro API key as a bearer token. One key grants every endpoint in this spec; per-key scopes are not available, so a client cannot request a narrower permission. Keys are created and revoked in the dashboard.

Path Parameters

taskId
string<uuid>
required

The ID of the task to fetch.

Response

Successful response with the task status and result if completed.

task
object
required

Common task summary fields shared across async task responses.

credits
object
required

Credit information for an async task.

webhook
object

Webhook delivery status. Present on COMPLETED and FAILED tasks created with a webhook.url.

response
object

Present only when the task is COMPLETED or FAILED. For a COMPLETED task it is the provider's result; for a FAILED task it is the error, { "error": { "code", "message", "details" } }, with details only when there is extra context.