**This endpoint is deprecated**

Queues a document for processing and returns a TaskResponse containing:
- Task ID for status polling
- Initial configuration
- File metadata
- Processing status
- Creation timestamp
- Presigned URLs for file access

The returned task will typically be in a `Starting` or `Processing` state.
Use the `GET /task/{task_id}` endpoint to poll for completion.

Create Task Multipart

Controls the processing and generation for the segment.
- `crop_image` controls whether to crop the file's images to the segment's bounding box.
  The cropped image will be stored in the segment's `image` field. Use `All` to always crop,
  or `Auto` to only crop when needed for post-processing.
- `html` is the HTML output for the segment, generated either through huerstics (`Auto`) or using Chunkr fine-tuned models (`LLM`)
- `llm` is the LLM-generated output for the segment, this uses off-the-shelf models to generate a custom output for the segment
- `markdown` is the Markdown output for the segment, generated either through huerstics (`Auto`) or using Chunkr fine-tuned models (`LLM`)

Bounding box for an item. It is used for chunks, segments and OCR results.

Collection of document segments that form this chunk.
When `target_chunk_length` > 0, contains the maximum number of segments
that fit within that length (segments remain intact).
Otherwise, contains exactly one segment.

Controls the setting for the chunking and post-processing of each chunk.

Whether to ignore headers and footers in the chunking process.
This is recommended as headers and footers break reading order across pages.

The target number of words in each chunk. If 0, each chunk will contain a single segment.

The number of seconds until task is deleted.
Expried tasks can **not** be updated, polled or accessed via web interface.

Whether to use high-resolution images for cropping and post-processing.

Controls the cropping strategy for an item (e.g. segment, chunk, etc.)
- `All` crops all images in the item
- `Auto` crops images only if required for post-processing

The confidence score of the recognized text.

Controls the Optical Character Recognition (OCR) strategy.
- `All`: Processes all pages with OCR. (Latency penalty: ~0.5 seconds per page)
- `Auto`: Selectively applies OCR only to pages with missing or low-quality text. When text layer is present the bounding boxes from the text layer are used.

The processed results of a document analysis task

Collection of document chunks, where each chunk contains one or more segments

Presigned URL to the image of the segment.

Height of the page containing the segment.

Width of the page containing the segment.

Controls the post-processing of each segment type.
Allows you to generate HTML and Markdown from chunkr models for each segment type.
By default, the HTML and Markdown are generated manually using the segmentation information except for `Table` and `Formula`.
You can optionally configure custom LLM prompts and models to generate an additional `llm` field
with LLM-processed content for each segment type.

All the possible types for a segment.
Note: Different configurations will produce different types.
Please refer to the documentation for more information.

Controls the segmentation strategy:
- `LayoutAnalysis`: Analyzes pages for layout elements (e.g., `Table`, `Picture`, `Formula`, etc.) using bounding boxes. Provides fine-grained segmentation and better chunking. (Latency penalty: ~TBD seconds per page).
- `Page`: Treats each page as a single segment. Faster processing, but without layout element detection and only simple chunking.

api key

Detailed information describing the task, its status and processed outputs

Internal server error related to creating the task

Chunkr

Introduction to Chunkr API

Task response

Model

Chunking

OCR Strategy

Structured Extraction

Chunks

Retrieves detailed information about a task by its ID, including:
- Processing status
- Task configuration
- Output data (if processing is complete)
- File metadata (name, page count)
- Timestamps (created, started, finished)
- Presigned URLs for accessing files

This endpoint can be used to:
1. Poll the task status during processing
2. Retrieve the final output once processing is complete
3. Access task metadata and configuration

Get Task

Delete a task by its ID.

Requirements:
- Task must have status `Succeeded` or `Failed`

Delete Task

**This endpoint is deprecated**

Updates an existing task's configuration and reprocesses the document.

Requirements:
- Task must have status `Succeeded` or `Failed`
- New configuration must be different from the current one

The returned task will typically be in a `Starting` or `Processing` state.
Use the `GET /task/{task_id}` endpoint to poll for completion.

Update Task Multipart

Cancel a task that hasn't started processing yet:
- For new tasks: Status will be updated to `Cancelled`
- For updating tasks: Task will revert to the previous state

Requirements:
- Task must have status `Starting`

Cancel Task

Updates an existing task's configuration and reprocesses the document.

Requirements:
- Task must have status `Succeeded` or `Failed`
- New configuration must be different from the current one

The returned task will typically be in a `Starting` or `Processing` state.
Use the `GET /task/{task_id}` endpoint to poll for completion.

Update Task

Retrieves a list of tasks

Example usage:
`GET /api/v1/tasks?page=1&limit=10&include_chunks=false`

Task

Tasks

Health

Create Task Multipart

Authorizations

Body

Response