Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lumina-ai-inc/chunkr/llms.txt

Use this file to discover all available pages before exploring further.

​
Task

The Task object represents a document processing job in Chunkr. It contains all the information about the task, including its configuration, status, and locations of input/output files.
​
task_id
string
required
The unique identifier for the task.
​
status
Status
required
The current status of the task.
​
configuration
Configuration
required
The processing configuration for the task. See Configuration for details.
​
created_at
DateTime<Utc>
required
The date and time when the task was created.
​
started_at
DateTime<Utc>
The date and time when the task processing started.
​
finished_at
DateTime<Utc>
The date and time when the task completed (successfully or with failure).
​
expires_at
DateTime<Utc>
The date and time when the task will expire and be deleted. Expired tasks cannot be updated, polled, or accessed.
​
file_name
string
The name of the uploaded file.
​
file_size
integer
required
The size of the uploaded file in bytes.
​
mime_type
string
The MIME type of the uploaded file (e.g., application/pdf).
​
page_count
integer
The total number of pages in the document.
​
message
string
A message describing the task’s current status or any errors that occurred.
​
task_url
string
The URL to check the status of this task.
​
user_id
string
required
The ID of the user who created the task.
​
api_key
string
The API key used to create the task (if applicable).
​
version
string
The version of Chunkr that processed this task.
​
input_location
string
required
The S3 location of the input file.
​
output_location
string
required
The S3 location of the output JSON file.
​
pdf_location
string
required
The S3 location of the processed PDF file.
​
image_folder_location
string
required
The S3 location of the folder containing extracted images.

​
TaskResponse

The TaskResponse object is returned when querying a task. It contains the task’s current state and optionally includes the output data.
​
task_id
string
required
The unique identifier for the task.
​
status
Status
required
The current status of the task.
​
configuration
Configuration
required
The processing configuration used for the task. See Configuration for details.
​
created_at
DateTime<Utc>
required
The date and time when the task was created and queued.
​
started_at
DateTime<Utc>
The date and time when the task processing started.
​
finished_at
DateTime<Utc>
The date and time when the task was finished.
​
expires_at
DateTime<Utc>
The date and time when the task will expire.
​
message
string
required
A message describing the task’s status or any errors that occurred.
​
output
OutputResponse
The processed output data. Only included when the task status is Succeeded and include_chunks=true is specified. See Output for details.
​
task_url
string
The presigned URL of the task.

Build docs developers (and LLMs) love

Get started for freeTalk to us