For the complete documentation index, see llms.txt. This page is also available as Markdown.

Jobs

One endpoint to check the state of any async resource.

Endpoints

MethodPathScopeCreditsDescription
GET/v1/jobs/{id}any read scope0Retrieve job state

Response

json
{ "object": "job", "id": "job_7yb0mr3ck9", "status": "running", "resource": { "object": "search", "id": "srch_9dm2pq4x1a" }, "progress": { "completed": 12, "total": 20 }, "error": null, "created_at": "…", "completed_at": null }

Polling guidance

Back off: 1s, 2s, 4s, capped at 10s. Do not poll faster than once a second — you will hit rate-limits before your job finishes. Prefer webhooks for anything that routinely exceeds 30 seconds.

job · webhook-endpoints · errors-and-retries

Last updated