Skip to main content
GET
/
api
/
v1
/
tasks
Get Tasks
curl --request GET \
  --url https://api.chunkr.ai/api/v1/tasks \
  --header 'Authorization: <api-key>'
[
  {
    "configuration": {
      "chunk_processing": {
        "ignore_headers_and_footers": true,
        "target_length": 512
      },
      "expires_in": 123,
      "high_resolution": true,
      "input_file_url": "<string>",
      "json_schema": "<any>",
      "model": null,
      "ocr_strategy": "All",
      "pipeline": null,
      "segment_processing": {
        "Caption": null,
        "Footnote": null,
        "Formula": null,
        "ListItem": null,
        "Page": null,
        "PageFooter": null,
        "PageHeader": null,
        "Picture": null,
        "SectionHeader": null,
        "Table": null,
        "Text": null,
        "Title": null
      },
      "segmentation_strategy": "LayoutAnalysis",
      "target_chunk_length": 123
    },
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z",
    "message": "<string>",
    "output": null,
    "started_at": "2023-11-07T05:31:56Z",
    "status": "Starting",
    "task_id": "<string>",
    "task_url": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
base64_urls
boolean

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

​
end
string<date-time>

End date

​
include_chunks
boolean

Whether to include chunks in the output response

​
limit
integer

Number of tasks per page

​
page
integer

Page number

​
start
string<date-time>

Start date

Response

Detailed information describing the task

​
configuration
object
required

The configuration used for the task.

​
created_at
string<date-time>
required

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

​
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.

​
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.

​
output
object | null

The processed results of a document analysis 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.