Skip to navigation
SDK Referencetask

Get task

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Path parameters

task_uuidstringRequired
Task UUID

Response

OK
completed_atstringOptional

The time the task reached a terminal status; absent while it is still in progress.

created_atstringOptional
The time the task was created.
errorobjectOptional

The error that caused the task to fail; also present on a partial task when the worker can name a single cause.

progressobjectOptional
The last processing stage a worker reported for this task. It is not cleared when the task finishes, so a completed task may still show its final stage.
resultmap from strings to anyOptional

Operation-specific output populated once the task reaches succeeded or partial, such as identifiers the operation could not return synchronously.

started_atstringOptional

The time a worker began processing the task; absent until then.

statusstringOptional

The task's current state: pending, processing, succeeded, partial, or failed.

typestringOptional
The kind of asynchronous operation the task represents.
updated_atstringOptional
The time the task was last updated.
uuidstringOptional
The unique identifier of the task, used to poll its status.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error