Skip to main content
GET
Get a search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

jobId
string<uuid>
required

The jobId returned by POST /search.

Response

The search's status, and its result once it has finished.

status
enum<string>
  • waiting: queued, not started yet.
  • delayed: waiting to be retried after a temporary problem.
  • active: running. progress.message says what it's doing.
  • completed: finished. The result is in result.
  • failed: couldn't be done. error says why, and you aren't charged.
Available options:
waiting,
delayed,
active,
completed,
failed
progress
object
result
object | null

The result once status is completed. null before that.

error
string | null

Why the search failed once status is failed, such as "Search cancelled". null otherwise.