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.string
required
The unique identifier for the task.
Status
required
The current status of the task.
Configuration
required
The processing configuration for the task. See Configuration for details.
DateTime<Utc>
required
The date and time when the task was created.
DateTime<Utc>
The date and time when the task processing started.
DateTime<Utc>
The date and time when the task completed (successfully or with failure).
DateTime<Utc>
The date and time when the task will expire and be deleted. Expired tasks cannot be updated, polled, or accessed.
string
The name of the uploaded file.
integer
required
The size of the uploaded file in bytes.
string
The MIME type of the uploaded file (e.g.,
application/pdf).integer
The total number of pages in the document.
string
A message describing the task’s current status or any errors that occurred.
string
The URL to check the status of this task.
string
required
The ID of the user who created the task.
string
The API key used to create the task (if applicable).
string
The version of Chunkr that processed this task.
string
required
The S3 location of the input file.
string
required
The S3 location of the output JSON file.
string
required
The S3 location of the processed PDF file.
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.string
required
The unique identifier for the task.
Status
required
The current status of the task.
Configuration
required
The processing configuration used for the task. See Configuration for details.
DateTime<Utc>
required
The date and time when the task was created and queued.
DateTime<Utc>
The date and time when the task processing started.
DateTime<Utc>
The date and time when the task was finished.
DateTime<Utc>
The date and time when the task will expire.
string
required
A message describing the task’s status or any errors that occurred.
OutputResponse
The processed output data. Only included when the task status is
Succeeded and include_chunks=true is specified. See Output for details.string
The presigned URL of the task.