# Chunkr

## Docs

- [Get all supported file types](https://docs.chunkr.ai/api-references/extras/get-all-supported-file-types.md): Returns a list of all file types supported by Chunkr, grouped by category.
Each category contains a list of formats, where each format includes an extension
paired with its corresponding MIME type.
- [Delete File](https://docs.chunkr.ai/api-references/files/delete-file.md): Delete file contents and scrub sensitive metadata.
Minimal metadata is retained for audit and usage reporting per ZDR policy
- [Download File Content](https://docs.chunkr.ai/api-references/files/download-file-content.md): Streams the file bytes directly if authorized. The response will set the
`Content-Type` header to the file's detected MIME type.
- [Get File](https://docs.chunkr.ai/api-references/files/get-file.md): Returns metadata for a file owned by the authenticated user.
The response includes a permanent `ch://files/{file_id}` URL,
file name, content type, size, user-provided metadata, and timestamps.

If the file is not found or the user is not authorized, the response will be 401 Unauthorized.
- [Get File URL](https://docs.chunkr.ai/api-references/files/get-file-url.md): Returns a presigned download URL by default. If `base64_urls=true`, returns
base64-encoded file content. Control expiry with `expires_in` (seconds).
- [List Files](https://docs.chunkr.ai/api-references/files/list-files.md): Lists files for the authenticated user with cursor-based pagination and optional filtering by date range.
- [Upload a file](https://docs.chunkr.ai/api-references/files/upload-a-file.md): Accepts multipart/form-data with fields:
- file: binary (required)
- file_metadata: string (optional, JSON string)
- [Health Check](https://docs.chunkr.ai/api-references/health/health-check.md): Confirmation that the service can respond to requests
- [Task extract updated](https://docs.chunkr.ai/api-references/task-extract-updated.md): An extract task has been updated - the event is sent when the status or message for a task changes.
- [Task parse updated](https://docs.chunkr.ai/api-references/task-parse-updated.md): A parse task has been updated - the event is sent when the status or message for a task changes.
- [Cancel Task](https://docs.chunkr.ai/api-references/tasks/cancel-task.md): 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`
- [Create Extract Task](https://docs.chunkr.ai/api-references/tasks/create-extract-task.md): Queues a document/parsed task for extraction and returns a `TaskResponse` with the
assigned `task_id`, initial configuration, file metadata, and timestamps.
The initial status is `Starting`.

Creates an extract task and returns its metadata immediately.
- [Create Parse Task](https://docs.chunkr.ai/api-references/tasks/create-parse-task.md): Queues a document for processing and returns a `TaskResponse` with the
assigned `task_id`, initial configuration, file metadata, and timestamps.
The initial status is `Starting`.

Creates a parse task and returns its metadata immediately.
- [Delete Task](https://docs.chunkr.ai/api-references/tasks/delete-task.md): Delete a task by its ID.

Requirements:
- Task must have status `Succeeded` or `Failed`
- [Get Extract Task](https://docs.chunkr.ai/api-references/tasks/get-extract-task.md): Retrieves the current state of an extract task.

Returns task details such as processing status, configuration, output (when
available), file metadata, and timestamps.

Typical uses:
- Poll a task during processing
- Retrieve the final output once processing is complete
- Access task metadata and configuration
- [Get Parse Task](https://docs.chunkr.ai/api-references/tasks/get-parse-task.md): Retrieves the current state of a parse task.

Returns task details such as processing status, configuration, output (when
available), file metadata, and timestamps.

Typical uses:
- Poll a task during processing
- Retrieve the final output once processing is complete
- Access task metadata and configuration
- [Get Task](https://docs.chunkr.ai/api-references/tasks/get-task.md): Retrieves the current state of a task.

Returns task details such as processing status, configuration, output (when
available), file metadata, and timestamps.

Typical uses:
- Poll a task during processing
- Retrieve the final output once processing is complete
- Access task metadata and configuration
- [List Tasks](https://docs.chunkr.ai/api-references/tasks/list-tasks.md): Lists tasks for the authenticated user with cursor-based pagination
and optional filtering by date range. Supports ascending or descending
sort order and optional inclusion of chunks/base64 URLs.
- [Get webhook URL](https://docs.chunkr.ai/api-references/webhook/get-webhook-url.md): Get or create webhook for user and return dashboard URL
- [Extract Examples](https://docs.chunkr.ai/pages/features/extract/examples.md): Extract structured data from documents using defined schemas.
- [Extract Outputs](https://docs.chunkr.ai/pages/features/extract/outputs.md): Understanding data returned by the Extract feature
- [Extract Overview](https://docs.chunkr.ai/pages/features/extract/overview.md): Transform documents into structured data with granular citations
- [Advanced Cases](https://docs.chunkr.ai/pages/features/parse/advanced-cases.md): Configuring the Parse feature for advanced use cases
- [Parse Outputs](https://docs.chunkr.ai/pages/features/parse/outputs.md): Understanding data returned by the Parse feature.
- [Parse Overview](https://docs.chunkr.ai/pages/features/parse/overview.md): Convert documents into LLM-ready data
- [Supported File types](https://docs.chunkr.ai/pages/get-started/file-types.md): A comprehensive list of all compatible file types
- [LLM Documentation](https://docs.chunkr.ai/pages/get-started/llm-docs.md): LLM-ready dev documentation for Chunkr AI
- [Developer Quickstart](https://docs.chunkr.ai/pages/get-started/quickstart.md): Get started in 2 minutes
- [Web Interface](https://docs.chunkr.ai/pages/get-started/web-interface.md): Create tasks and visually inspect output quality without writing any code
- [Welcome to Chunkr](https://docs.chunkr.ai/pages/get-started/welcome.md): Complex, messy documents to high-quality data
- [Deploy Chunkr on your infrastructure](https://docs.chunkr.ai/pages/security/on-premise.md)
- [Security & Trust at Chunkr](https://docs.chunkr.ai/pages/security/policies.md)
- [Usage Limits](https://docs.chunkr.ai/pages/task-system/limits.md): Task timeouts and file size restrictions.
- [Task System Overview](https://docs.chunkr.ai/pages/task-system/overview.md): Understanding Chunkr's task-based processing system
- [Basic Task Handling](https://docs.chunkr.ai/pages/task-system/task-handling.md): Create tasks, check their status, and retrieve processed results
- [Example](https://docs.chunkr.ai/pages/task-system/webhooks/examples.md): Quick, copy‑pasteable snippets for receiving Chunkr webhooks, verifying them with Svix, and then fetching the related task via the Chunkr SDK.
- [Overview](https://docs.chunkr.ai/pages/task-system/webhooks/overview.md)
- [Troubleshooting](https://docs.chunkr.ai/pages/task-system/webhooks/troubleshooting.md)