For the complete documentation index, see llms.txt. This page is also available as Markdown.
Job
A job is the async execution behind a resource. There is one status vocabulary across the whole API, so you write the wait logic once.
The status enum
| Status | Terminal? | Meaning |
|---|---|---|
queued | no | Accepted, not started |
running | no | In progress |
succeeded | yes | Results available on the resource |
failed | yes | See error on the resource; do not blind-retry |
canceled | yes | You called /cancel |
Which resources are async
Search, Extraction, TopicSearch, and Document parsing. Everything else is synchronous.
Three ways to wait
Poll the resource. Back off; do not poll faster than once a second.
Webhook — subscribe to
*.completedand*.failed. See webhook.SDK
.wait()— handles backoff and timeout for you.
This endpoint is asynchronous
Reuse this callout verbatim on every async endpoint page, linking here.
Related
Last updated