Sign in

v1

latestOpenAPI 3.1.02026-07-13175151.8 KB
Tasks

Get Task

Retrieves the current state of a task.

Returns task details such as processing status, configuration, output (when available), file metadata, and timestamps.

Typical uses:

  • Poll a task during processing
  • Retrieve the final output once processing is complete
  • Access task metadata and configuration
get/tasks/{task_id}

Path parameters

task_idstring nullable required

Id of the task to retrieve

Query parameters

base64_urlsboolean

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

include_chunksboolean

Whether to include chunks in the output response

Response

Task details.

completedboolean required

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

created_atstring date-time required

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

expires_atstring date-time nullable

The date and time when the task will expire.

finished_atstring date-time nullable

The date and time when the task was finished.

input_file_urlstring nullable

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

messagestring required

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

parse_task_idstring nullable

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

started_atstring date-time nullable

The date and time when the task was started.

status'Starting' | 'Processing' | 'Succeeded' | 'Failed' | 'Cancelled' required

The status of the task.

task_idstring required

The unique identifier for the task.

task_type'Parse' | 'Extract' required
task_urlstring nullable

The presigned URL of the task.