Sign inGet an API key

Get task status

The status and nothing else — the endpoint to poll on an interval. It also accepts a public access token, so browser code can follow a task without holding an API key.

GET/tasks/{id}/status
AuthAPI keyorPublic access tokenHow to send it

The endpoint to poll. It returns the status and nothing else, from a cache, and it accepts the task's public access token, so browser code can follow a task without an API key.

Poll for results has a loop with backoff. A webhook avoids polling entirely.

Path parameters#

idstringrequired

The task to poll.

e.g. "tsk_01KE7XWWEQ4MCGWKBQKJ1G47RP"

Response#

200Task status returned

dataobjectrequired
statusstringrequired
"completed""failed""pending"

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.