GET
/
tasks
/
{task_id}
Get Task
curl --request GET \
  --url https://api.chunkr.ai/api/v1/tasks/{task_id} \
  --header 'Authorization: <api-key>'
{
  "configuration": {
    "chunk_processing": {
      "ignore_headers_and_footers": true,
      "target_length": 4096,
      "tokenizer": {
        "Enum": "Word"
      }
    },
    "client_version": null,
    "error_handling": "Fail",
    "expires_in": 123,
    "high_resolution": true,
    "input_file_url": "<string>",
    "llm_processing": {
      "fallback_strategy": "None",
      "llm_model_id": "<string>",
      "max_completion_tokens": 1,
      "temperature": 123
    },
    "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": 1
  },
  "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

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

​
wait_for_completion
boolean

Whether to wait for the task to complete

Response

Task details. Returned immediately if the task is terminal, or after a brief hold when wait_for_completion=true and the task completes within the window.

​
configuration
object
required
​
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.