Get Task

Retrieve detailed information about a task by its ID, including processing status and output data

Endpoint

GET /api/v1/task/{task_id}

Authentication

This endpoint requires API key authentication via the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

task_id · string · required

The unique identifier of the task to retrieve

Query Parameters

base64_urls · boolean · default: false

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

include_chunks · boolean · default: true

Whether to include chunks in the output response. Set to false for faster responses when you only need task metadata.

Response

task_id · string

The unique identifier for the task

status · enum

The current status of the task:

• Starting: Task is queued and waiting to begin
• Processing: Task is currently being processed
• Succeeded: Task completed successfully
• Failed: Task failed during processing
• Cancelled: Task was cancelled

created_at · string

The date and time when the task was created and queued (ISO 8601 format)

started_at · string

The date and time when the task started processing (ISO 8601 format)

finished_at · string

The date and time when the task was finished (ISO 8601 format)

expires_at · string

The date and time when the task will expire (ISO 8601 format)

message · string

A message describing the task’s status or any errors that occurred

task_url · string

The presigned URL of the task

configuration · object

The complete task configuration including:

Show properties

input_file_url · string

Presigned URL of the input file

ocr_strategy · enum

OCR strategy used: All or Auto

segmentation_strategy · enum

Segmentation strategy used: LayoutAnalysis or Page

high_resolution · boolean

Whether high-resolution processing was enabled

expires_in · integer

Number of seconds until task deletion

error_handling · enum

Error handling strategy: Fail or Continue

chunk_processing · object

Chunking configuration settings

segment_processing · object

Segment processing configuration for each segment type

llm_processing · object

LLM configuration settings

output · object

Output data (only present when status is Succeeded and include_chunks is true)

Show properties

chunks · array

Array of processed chunks, each containing:

• chunk_id: Unique identifier for the chunk
• chunk_index: Index of the chunk in the document
• segments: Array of segments within the chunk
• embed: Aggregated content based on embed_sources configuration

file_name · string

Original file name

page_count · integer

Total number of pages in the document

pdf_url · string

Presigned URL (or base64) to access the processed PDF

Status Codes

• 200: Task retrieved successfully
• 404: Task not found or expired
• 500: Internal server error

Examples

cURL (Basic)

curl -X GET "https://api.chunkr.ai/api/v1/task/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Use Cases

This endpoint can be used to:

1. Poll task status during processing - Check if a task has moved from Starting → Processing → Succeeded
2. Retrieve final output - Get processed chunks, segments, and metadata once processing is complete
3. Access task metadata - Get file information, page count, timestamps, and configuration
4. Monitor task progress - Track when tasks were created, started, and finished

Notes

• Set include_chunks=false for faster responses when you only need status information
• The output field is only populated when the task status is Succeeded
• Expired tasks will return a 404 error
• Use base64_urls=true if you need to embed resources directly in your application
• For long-running tasks, implement exponential backoff in your polling logic