Skip to main content
GET
Get Task

Authorizations

Authorization
string
header
required

Path Parameters

task_id
string | null
required

Id of the task to retrieve

Query Parameters

base64_urls
boolean

Whether to return base64 encoded URLs. If false, the URLs will be returned as presigned URLs.

include_chunks
boolean

Whether to include chunks in the output response

Response

Task details.

completed
boolean
required

True when the task reaches a terminal state i.e. status is Succeeded or Failed or Cancelled

configuration
Parse · object
required

Unified configuration type that can represent either parse or extract configurations

created_at
string<date-time>
required

The date and time when the task was created and queued.

file_info
object
required

Information about the input file.

message
string
required

A message describing the task's status or any errors that occurred.

status
enum<string>
required

The status of the task.

Available options:
Starting,
Processing,
Succeeded,
Failed,
Cancelled
task_id
string
required

The unique identifier for the task.

task_type
enum<string>
required
Available options:
Parse,
Extract
version_info
object
required

Version information for the task.

expires_at
string<date-time> | null

The date and time when the task will expire.

finished_at
string<date-time> | null

The date and time when the task was finished.

input_file_url
string | null
deprecated

The presigned URL of the input file. Deprecated use file_info.url instead.

output
Parse · object

Unified output type that can represent either parse or extract results

parse_task_id
string | null

The ID of the source parse task that was used for the task

started_at
string<date-time> | null

The date and time when the task was started.

task_url
string | null

The presigned URL of the task.