curl --request POST \
--url https://api.chunkr.ai/api/v1/tasks/parse \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"chunk_processing": null,
"error_handling": null,
"expires_in": 123,
"file": "<string>",
"file_name": "<string>",
"llm_processing": null,
"ocr_strategy": null,
"pipeline": null,
"segment_processing": null,
"segmentation_strategy": null
}'
{
"configuration": {
"chunk_processing": {
"ignore_headers_and_footers": true,
"target_length": 4096,
"tokenizer": {
"Enum": "Word"
}
},
"client_version": null,
"error_handling": "Fail",
"expires_in": 123,
"high_resolution": true,
"input_file_url": "<string>",
"llm_processing": {
"fallback_strategy": "None",
"llm_model_id": "<string>",
"max_completion_tokens": 1,
"temperature": 123
},
"ocr_strategy": "All",
"pipeline": null,
"segment_processing": {
"Caption": null,
"Footnote": null,
"Formula": null,
"ListItem": null,
"Page": null,
"PageFooter": null,
"PageHeader": null,
"Picture": null,
"SectionHeader": null,
"Table": null,
"Text": null,
"Title": null
},
"segmentation_strategy": "LayoutAnalysis",
"target_chunk_length": 1
},
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"output": null,
"started_at": "2023-11-07T05:31:56Z",
"status": "Starting",
"task_id": "<string>",
"task_url": "<string>"
}
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 task and returns its metadata immediately.
curl --request POST \
--url https://api.chunkr.ai/api/v1/tasks/parse \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"chunk_processing": null,
"error_handling": null,
"expires_in": 123,
"file": "<string>",
"file_name": "<string>",
"llm_processing": null,
"ocr_strategy": null,
"pipeline": null,
"segment_processing": null,
"segmentation_strategy": null
}'
{
"configuration": {
"chunk_processing": {
"ignore_headers_and_footers": true,
"target_length": 4096,
"tokenizer": {
"Enum": "Word"
}
},
"client_version": null,
"error_handling": "Fail",
"expires_in": 123,
"high_resolution": true,
"input_file_url": "<string>",
"llm_processing": {
"fallback_strategy": "None",
"llm_model_id": "<string>",
"max_completion_tokens": 1,
"temperature": 123
},
"ocr_strategy": "All",
"pipeline": null,
"segment_processing": {
"Caption": null,
"Footnote": null,
"Formula": null,
"ListItem": null,
"Page": null,
"PageFooter": null,
"PageHeader": null,
"Picture": null,
"SectionHeader": null,
"Table": null,
"Text": null,
"Title": null
},
"segmentation_strategy": "LayoutAnalysis",
"target_chunk_length": 1
},
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"output": null,
"started_at": "2023-11-07T05:31:56Z",
"status": "Starting",
"task_id": "<string>",
"task_url": "<string>"
}
JSON request to create a task
The body is of type object
.
Task created successfully.
The response is of type object
.
Was this page helpful?