Tasks
Get Task
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
GET
/
tasks
/
{task_id}
Python
import os
from chunkr_ai import Chunkr
client = Chunkr(
api_key=os.environ.get("CHUNKR_API_KEY"), # This is the default and can be omitted
)
task = client.tasks.get("task_id")
print(task.status)import Chunkr from 'chunkr-ai';
const client = new Chunkr({
apiKey: process.env['CHUNKR_API_KEY'], // This is the default and can be omitted
});
const task = await client.tasks.get('task_id');
console.log(task.status);
curl --request GET \
--url https://api.chunkr.ai/tasks/{task_id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.chunkr.ai/tasks/{task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chunkr.ai/tasks/{task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.chunkr.ai/tasks/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.chunkr.ai/tasks/{task_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chunkr.ai/tasks/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"completed": true,
"configuration": {
"chunk_processing": {
"ignore_headers_and_footers": null,
"target_length": 4096,
"tokenizer": {
"Enum": "Word"
}
},
"error_handling": "Fail",
"ocr_strategy": "All",
"pipeline": "Chunkr",
"segment_processing": {
"Caption": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Footnote": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"FormRegion": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Formula": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"GraphicalItem": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Legend": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"LineNumber": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"ListItem": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Page": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"PageFooter": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"PageHeader": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"PageNumber": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Picture": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Table": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Text": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Title": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Unknown": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
}
},
"segmentation_strategy": "LayoutAnalysis"
},
"created_at": "2023-11-07T05:31:56Z",
"file_info": {
"url": "<string>",
"mime_type": "<string>",
"name": "<string>",
"page_count": 1,
"ss_cell_count": 1
},
"message": "<string>",
"status": "Starting",
"task_id": "<string>",
"task_type": "Parse",
"version_info": {
"client_version": "Legacy",
"server_version": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"input_file_url": "<string>",
"output": {
"chunks": [
{
"chunk_length": 1,
"segments": [
{
"bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"page_height": 123,
"page_number": 1,
"page_width": 123,
"segment_id": "<string>",
"segment_type": "Caption",
"confidence": 123,
"content": "<string>",
"description": "<string>",
"embed": "<string>",
"image": "<string>",
"llm": "<string>",
"ocr": [
{
"bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"text": "<string>",
"confidence": 123,
"ocr_id": "<string>",
"ss_cell_ref": "<string>"
}
],
"segment_length": 1,
"ss_cells": [
{
"cell_id": "<string>",
"range": "<string>",
"text": "<string>",
"formula": "<string>",
"hyperlink": "<string>",
"style": {
"align": "Left",
"bg_color": "<string>",
"font_face": "<string>",
"is_bold": true,
"text_color": "<string>",
"valign": "Top"
},
"value": "<string>"
}
],
"ss_header_bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"ss_header_ocr": [
{
"bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"text": "<string>",
"confidence": 123,
"ocr_id": "<string>",
"ss_cell_ref": "<string>"
}
],
"ss_header_range": "<string>",
"ss_header_text": "<string>",
"ss_range": "<string>",
"ss_sheet_name": "<string>",
"text": "<string>"
}
],
"chunk_id": "<string>",
"content": "<string>",
"embed": "<string>"
}
],
"file_name": "<string>",
"mime_type": "<string>",
"page_count": 1,
"pages": [
{
"image": "<string>",
"page_height": 123,
"page_number": 1,
"page_width": 123,
"dpi": 123,
"ss_sheet_name": "<string>"
}
],
"pdf_url": "<string>"
},
"parse_task_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"task_url": "<string>"
}<string><string><string>Query Parameters
Response
Task details.
Was this page helpful?
⌘I
Python
import os
from chunkr_ai import Chunkr
client = Chunkr(
api_key=os.environ.get("CHUNKR_API_KEY"), # This is the default and can be omitted
)
task = client.tasks.get("task_id")
print(task.status)import Chunkr from 'chunkr-ai';
const client = new Chunkr({
apiKey: process.env['CHUNKR_API_KEY'], // This is the default and can be omitted
});
const task = await client.tasks.get('task_id');
console.log(task.status);
curl --request GET \
--url https://api.chunkr.ai/tasks/{task_id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.chunkr.ai/tasks/{task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chunkr.ai/tasks/{task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.chunkr.ai/tasks/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.chunkr.ai/tasks/{task_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chunkr.ai/tasks/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"completed": true,
"configuration": {
"chunk_processing": {
"ignore_headers_and_footers": null,
"target_length": 4096,
"tokenizer": {
"Enum": "Word"
}
},
"error_handling": "Fail",
"ocr_strategy": "All",
"pipeline": "Chunkr",
"segment_processing": {
"Caption": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Footnote": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"FormRegion": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Formula": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"GraphicalItem": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Legend": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"LineNumber": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"ListItem": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Page": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"PageFooter": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"PageHeader": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"PageNumber": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Picture": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Table": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Text": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Title": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
},
"Unknown": {
"crop_image": "All",
"description": null,
"extended_context": null,
"format": "Html",
"llm": "<string>",
"strategy": "LLM"
}
},
"segmentation_strategy": "LayoutAnalysis"
},
"created_at": "2023-11-07T05:31:56Z",
"file_info": {
"url": "<string>",
"mime_type": "<string>",
"name": "<string>",
"page_count": 1,
"ss_cell_count": 1
},
"message": "<string>",
"status": "Starting",
"task_id": "<string>",
"task_type": "Parse",
"version_info": {
"client_version": "Legacy",
"server_version": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"input_file_url": "<string>",
"output": {
"chunks": [
{
"chunk_length": 1,
"segments": [
{
"bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"page_height": 123,
"page_number": 1,
"page_width": 123,
"segment_id": "<string>",
"segment_type": "Caption",
"confidence": 123,
"content": "<string>",
"description": "<string>",
"embed": "<string>",
"image": "<string>",
"llm": "<string>",
"ocr": [
{
"bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"text": "<string>",
"confidence": 123,
"ocr_id": "<string>",
"ss_cell_ref": "<string>"
}
],
"segment_length": 1,
"ss_cells": [
{
"cell_id": "<string>",
"range": "<string>",
"text": "<string>",
"formula": "<string>",
"hyperlink": "<string>",
"style": {
"align": "Left",
"bg_color": "<string>",
"font_face": "<string>",
"is_bold": true,
"text_color": "<string>",
"valign": "Top"
},
"value": "<string>"
}
],
"ss_header_bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"ss_header_ocr": [
{
"bbox": {
"height": 123,
"left": 123,
"top": 123,
"width": 123
},
"text": "<string>",
"confidence": 123,
"ocr_id": "<string>",
"ss_cell_ref": "<string>"
}
],
"ss_header_range": "<string>",
"ss_header_text": "<string>",
"ss_range": "<string>",
"ss_sheet_name": "<string>",
"text": "<string>"
}
],
"chunk_id": "<string>",
"content": "<string>",
"embed": "<string>"
}
],
"file_name": "<string>",
"mime_type": "<string>",
"page_count": 1,
"pages": [
{
"image": "<string>",
"page_height": 123,
"page_number": 1,
"page_width": 123,
"dpi": 123,
"ss_sheet_name": "<string>"
}
],
"pdf_url": "<string>"
},
"parse_task_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"task_url": "<string>"
}<string><string><string>