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

Response

200
application/json

Detailed information describing the task

The response is of type object.