GET
/
api
/
v1
/
task
/
{task_id}
curl --request GET \
  --url https://api.chunkr.ai/api/v1/task/{task_id} \
  --header 'Authorization: <api-key>'
{
  "configuration": {
    "json_schema": {
      "properties": [
        {
          "default": "<string>",
          "description": "<string>",
          "name": "<string>",
          "title": "<string>",
          "type": "<string>"
        }
      ],
      "title": "<string>",
      "type": "<string>"
    },
    "model": "Fast",
    "ocr_strategy": "Auto",
    "segmentation_strategy": "LayoutAnalysis",
    "target_chunk_length": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "file_name": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "input_file_url": "<string>",
  "message": "<string>",
  "output": {
    "chunks": [
      {
        "chunk_length": 123,
        "segments": [
          {
            "bbox": {
              "height": 123,
              "left": 123,
              "top": 123,
              "width": 123
            },
            "content": "<string>",
            "html": "<string>",
            "image": "<string>",
            "markdown": "<string>",
            "ocr": [
              {
                "bbox": {
                  "height": 123,
                  "left": 123,
                  "top": 123,
                  "width": 123
                },
                "confidence": 123,
                "text": "<string>"
              }
            ],
            "page_height": 123,
            "page_number": 1,
            "page_width": 123,
            "segment_id": "<string>",
            "segment_type": "Title"
          }
        ]
      }
    ],
    "extracted_json": {
      "extracted_fields": [
        {
          "field_type": "<string>",
          "name": "<string>",
          "value": "<any>"
        }
      ],
      "schema_type": "<string>",
      "title": "<string>"
    }
  },
  "page_count": 123,
  "pdf_url": "<string>",
  "status": "Starting",
  "task_id": "<string>",
  "task_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
task_id
string
required

Id of the task to retrieve

Response

200
application/json
Detailed information describing the task
​
configuration
object
required
​
created_at
string
required
​
message
string
required
​
status
enum<string>
required
Available options:
Starting,
Processing,
Succeeded,
Failed,
Canceled
​
task_id
string
required
​
expires_at
string | null
​
file_name
string | null
​
finished_at
string | null
​
input_file_url
string | null
​
output
object
​
page_count
integer | null
​
pdf_url
string | null
​
task_url
string | null
Create TaskDelete Task