Skip to main content
GET
Read a task
Merging guests and computing a merge confidence both answer with a location header pointing here. The task path sits outside the entity, so the identifier from the header is the whole address you need.

Authorizations

Authorization
string
header
required

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

Path Parameters

task_id
string<uuid>
required

Identifier of the task, taken from the location header of the operation.

Response

The task

progress
integer

Completion percentage, 100 once the task has ended.

status
enum<string>

State of the task.

Available options:
pending,
running,
completed,
failed
result
any

Result of the task, shaped by the operation: a confidence score for a merge confidence computation, an object carrying the resource identifier for a merge.

error
string

Reason the task failed. Absent on a completed task.

startedAt
string<date-time>
endedAt
string<date-time>