Get Async Task Status

Poll the status of an asynchronous task. Returns the current state of the task and, when complete, the result or error. This endpoint is generic — it works for any task enqueued by an asynchronous Sefaria API (e.g. POST /api/find-refs).

States:

  • PENDING — The task has not yet started (or the task ID is unknown).
  • STARTED — The task is currently being executed.
  • RETRY — The task failed and is being retried.
  • SUCCESS — The task completed successfully. The result field contains the task output; its shape depends on which API enqueued the task.
  • FAILURE — The task failed permanently. The error field contains the error message.

HTTP status codes:

  • 202 — Task is still running (state is PENDING, STARTED, or RETRY).
  • 200 — Task completed successfully.
  • 500 — Task failed permanently.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The task ID returned by an asynchronous API endpoint (e.g. POST /api/find-refs).

Responses

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