Skip to main content
POST
Read the answer of a job

Authorizations

Authorization
string
header
required

An API key, orbb_sk_…, created in the console; or the console’s session token. See Authentication.

Body

application/json
id
string
required

Names the job to read: the job.id of a 202 answer. Spaces around it are ignored; a blank value is answered 400 invalid_body. A value that is not a job id, an unknown id, or the id of a job started under another account is answered 404 not_found.

A job is read with any key of the account that started it, or with that account’s console session.

See also /v1/job, Jobs.

Required string length: 1 - 512

Response

The job is done: the 200 body of the call that started it, or a failed job (job.status FAILED). A resolve answer carries resolution; a circle or paths answer, subject; an edge answer, a and b.

resolution
object

Whether, and how, the person was identified. Present in every resolve 200; a body with job only is a job answer.

person
object

The person found. Present only when resolution.status is RESOLVED.

job
object

The job that searched, with status DONE. Absent in a resolve by id.