Skip to navigation
Prep API Reference

Wait until a job or task finishes, then return its status

Holds the connection open with no server-side timeout.

Authentication

AuthorizationBearer
Your API key

Path parameters

api_versionenumRequired
Allowed values:
task_idstringRequired

Response

OK
statusstringformat: "^(in-progress|(done|failed|cancelled)(-(done|failed|cancelled))*)$"

‘in-progress’, or the end states of the task and its children joined with ’-’, in any order, e.g. ‘done-failed’

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
500
Internal Server Error
503
Service Unavailable Error