Wait For Jobs

Block until every supplied job has finished, or until maxWaitSeconds elapses - whichever comes first.

This is a convenience for automations that would otherwise poll in a loop. Submit the job ids you are waiting on and the call returns as soon as they are all finished.

A timeout is not an error. If the jobs are still running when the wait elapses, the call still returns 200 with allComplete: false and the current status of each job - simply call again with the ids that are still processing.

allComplete is true once every job has reached a terminal state, whether completed or error. Check anyError to tell the two apart. Unknown job ids come back with a null status rather than failing the whole request.

This endpoint consumes no credits.

Body Params
jobIds
array of strings
required

Job ids to wait for. Any job type.

Jobids*
integer
Defaults to 30

Seconds to wait before returning. Capped at 60. Returns as soon as every job is finished.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json