Get task status (GET /tasks/{id}/status)

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

Task status returned

dataobjectrequired

statusstringrequired: "pending""completed""failed"

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.