# Chunkr

## Docs

- [Health Check](https://docs.chunkr.ai/api-references/health/health-check.md): Confirmation that the service can respond to requests
- [Cancel Task](https://docs.chunkr.ai/api-references/task/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 Task](https://docs.chunkr.ai/api-references/task/create-task.md): 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.
- [Delete Task](https://docs.chunkr.ai/api-references/task/delete-task.md): Delete a task by its ID.

Requirements:
- Task must have status `Succeeded` or `Failed`
- [Get Task](https://docs.chunkr.ai/api-references/task/get-task.md): 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
- [Update Task](https://docs.chunkr.ai/api-references/task/update-task.md): Updates an existing task's configuration and reprocesses the document.
The original configuration will be used for all values that are not provided in the update.

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.
- [Get Tasks](https://docs.chunkr.ai/api-references/tasks/get-tasks.md): Retrieves a list of tasks

Example usage:
`GET /api/v1/tasks?page=1&limit=10&include_chunks=false`
- [Chunking](https://docs.chunkr.ai/docs/features/chunking.md): Chunking
- [Segmentation Strategy](https://docs.chunkr.ai/docs/features/layout-analysis/segmentation_strategy.md): Controls the segmentation strategy
- [What is Layout Analysis?](https://docs.chunkr.ai/docs/features/layout-analysis/what.md): Understand the importance of layout analysis in document processing
- [Optical Character Recognition (OCR)](https://docs.chunkr.ai/docs/features/ocr.md): Extract text from images
- [Configuration](https://docs.chunkr.ai/docs/features/overview.md): Configure the API to your needs
- [Pipeline](https://docs.chunkr.ai/docs/features/pipeline.md): Choose providers to process your documents
- [Segment Processing](https://docs.chunkr.ai/docs/features/segment-processing.md): Post-processing of segments
- [Changelog](https://docs.chunkr.ai/docs/get-started/changelog.md)
- [LLM Documentation](https://docs.chunkr.ai/docs/get-started/llm.md): LLM-ready documentation for Chunkr AI
- [Chunkr AI](https://docs.chunkr.ai/docs/get-started/overview.md): Open Source Document Intelligence
- [Developer Quickstart](https://docs.chunkr.ai/docs/get-started/quickstart.md): Learn how to get started with Chunkr AI API
- [Docker compose](https://docs.chunkr.ai/docs/self-hosting/docker-compose.md)
- [Kubernetes](https://docs.chunkr.ai/docs/self-hosting/kubernetes.md)
- [Bulk Upload](https://docs.chunkr.ai/docs/use-cases/bulk-upload.md): Learn how to efficiently process multiple files with Chunkr AI
- [Configuration](https://docs.chunkr.ai/sdk/configuration.md): Learn how to configure tasks in Chunkr AI
- [Canceling Tasks](https://docs.chunkr.ai/sdk/data-operations/cancel.md): Learn how to cancel queued tasks in Chunkr AI
- [Creating Tasks](https://docs.chunkr.ai/sdk/data-operations/create.md): Learn how to upload files and create processing tasks with Chunkr AI
- [Deleting Tasks](https://docs.chunkr.ai/sdk/data-operations/delete.md): Learn how to delete tasks in Chunkr AI
- [Getting Tasks](https://docs.chunkr.ai/sdk/data-operations/get.md): Learn how to retrieve and read task information from Chunkr AI
- [Updating Tasks](https://docs.chunkr.ai/sdk/data-operations/update.md): Learn how to update existing tasks in Chunkr AI
- [Export to different formats](https://docs.chunkr.ai/sdk/export.md)
- [Installation](https://docs.chunkr.ai/sdk/installation.md)
- [Polling the TaskResponse](https://docs.chunkr.ai/sdk/polling.md)
- [Using Chunkr AI SDK](https://docs.chunkr.ai/sdk/usage.md)


## Optional

- [GitHub](https://github.com/lumina-ai-inc/chunkr)
- [Discord](https://discord.gg/XzKWFByKzW)
- [Twitter](https://x.com/chunkrai)