Get Chunk by ID

GET

https://api.runcaptain.com/v3/collections/:collection_name/chunks/:chunk_id

GET

/v3/collections/:collection_name/chunks/:chunk_id

1 import json
2 import requests
3 
4 BASE_URL = "https://api.runcaptain.com"
5 API_KEY = "your_api_key"
6 COLLECTION_NAME = "my_documents"
7 CHUNK_ID = "doc_abc123:0"
8 
9 headers = {
10     "Authorization": f"Bearer {API_KEY}",
11 }
12 
13 params = {
14     "document_id": "example_document_id",
15     "include_regions": False,
16     "include_metadata": True
17 }
18 
19 response = requests.get(
20     f"{BASE_URL}/v3/collections/{COLLECTION_NAME}/chunks/{CHUNK_ID}",
21     headers=headers,
22     params=params,
23     timeout=30.0
24 )
25 
26 print(json.dumps(response.json(), indent=2))

1 {
2   "collection_name": "research_library",
3   "chunk": {
4     "chunk_id": "chunk_agri_report_001",
5     "document_id": "doc_climate_agriculture_2024",
6     "text": "Recent studies show that climate change affects crop yields through heat stress, shifting precipitation, and more frequent extreme weather events.",
7     "location": {
8       "page_start": 12,
9       "page_end": 13,
10       "chunk_index": 4,
11       "parent_chunk_index": 1
12     },
13     "regions": [
14       {
15         "type": "text",
16         "text": "Projected maize yield declines under high temperature scenarios",
17         "page": 12,
18         "bbox": {
19           "x": 0.18,
20           "y": 0.24,
21           "width": 0.62,
22           "height": 0.08
23         },
24         "confidence": "high"
25       },
26       {
27         "type": "chart",
28         "page": 13,
29         "bbox": {
30           "x": 0.12,
31           "y": 0.31,
32           "width": 0.76,
33           "height": 0.42
34         },
35         "confidence": "medium",
36         "image_url": "https://storage.example.com/previews/climate-agriculture-chart-p13.png",
37         "description": "Chart comparing projected crop yield changes by region."
38       }
39     ],
40     "custom_metadata": {
41       "review_status": "peer_reviewed",
42       "topic": "agriculture"
43     },
44     "metadata": {
45       "section": "Projected yield impacts",
46       "page_count": 2
47     }
48   },
49   "warnings": []
50 }

Fetch one chunk by ID with optional regions and metadata.

Path parameters

collection_namestringRequired

chunk_idstringRequired

Query parameters

document_idstring or nullOptional

include_regionsbooleanOptionalDefaults to false

include_metadatabooleanOptionalDefaults to true

Response

Get Chunk response.

collection_namestring

chunkobject

warningslist of strings

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error