Skip to main content
GET
/
tasks
List Tasks
curl --request GET \
  --url https://api.chunkr.ai/tasks \
  --header 'Authorization: <api-key>'
{
  "has_more": true,
  "next_cursor": "2023-11-07T05:31:56Z",
  "tasks": [
    {
      "completed": true,
      "configuration": {
        "chunk_processing": {
          "ignore_headers_and_footers": true,
          "target_length": 1,
          "tokenizer": {
            "Enum": "<any>"
          }
        },
        "error_handling": "Fail",
        "ocr_strategy": "All",
        "pipeline": "Azure",
        "segment_processing": null,
        "segmentation_strategy": "LayoutAnalysis"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "file_info": {
        "mime_type": "<string>",
        "name": "<string>",
        "page_count": 1,
        "ss_cell_count": 1,
        "url": "<string>"
      },
      "finished_at": "2023-11-07T05:31:56Z",
      "input_file_url": "<string>",
      "message": "<string>",
      "output": null,
      "parse_task_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "status": "Starting",
      "task_id": "<string>",
      "task_type": "Parse",
      "task_url": "<string>",
      "version_info": {
        "client_version": "Legacy",
        "server_version": "<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

​
cursor
string<date-time>

Cursor for pagination (timestamp)

​
start
string<date-time>

Start date

​
sort
enum<string>

Sort order: 'asc' for ascending, 'desc' for descending (default)

Available options:
asc,
desc
​
task_types
enum<string>[]

Filter by one or more task types

​
statuses
enum<string>[]

Filter by one or more statuses

Response

Paginated list of tasks

​
has_more
boolean
required
​
tasks
object[]
required
​
next_cursor
string<date-time> | null