Get Chunks | Captain Docs

import requests
url = "https://host.com/v3/collections/collection_name/chunks"
querystring = {"document_id":"document_id","limit":"1","cursor":"1","include_regions":"true","include_metadata":"true"}
response = requests.get(url, params=querystring)
print(response.json())

{
  "collection_name": "research_library",
  "document_id": "doc_climate_agriculture_2024",
  "total_results": 42,
  "limit": 2,
  "chunks": [
    {
      "chunk_id": "chunk_agri_report_001",
      "document_id": "doc_climate_agriculture_2024",
      "text": "Recent studies show that climate change affects crop yields through heat stress, shifting precipitation, and more frequent extreme weather events.",
      "location": {
        "page_start": 12,
        "page_end": 13,
        "chunk_index": 4,
        "parent_chunk_index": 1
      },
      "regions": [
        {
          "type": "text",
          "text": "Projected maize yield declines under high temperature scenarios",
          "page": 12,
          "bbox": {
            "x": 0.18,
            "y": 0.24,
            "width": 0.62,
            "height": 0.08
          },
          "confidence": "high"
        },
        {
          "type": "chart",
          "page": 13,
          "bbox": {
            "x": 0.12,
            "y": 0.31,
            "width": 0.76,
            "height": 0.42
          },
          "confidence": "medium",
          "image_url": "https://storage.example.com/previews/climate-agriculture-chart-p13.png",
          "description": "Chart comparing projected crop yield changes by region."
        }
      ],
      "custom_metadata": {
        "review_status": "peer_reviewed",
        "topic": "agriculture"
      },
      "metadata": {
        "section": "Projected yield impacts",
        "page_count": 2
      }
    },
    {
      "chunk_id": "chunk_agri_report_002",
      "document_id": "doc_climate_agriculture_2024",
      "text": "Adaptation measures include drought resistant seed varieties, improved irrigation scheduling, and soil moisture monitoring.",
      "location": {
        "page_start": 14,
        "page_end": 14,
        "chunk_index": 5,
        "parent_chunk_index": 1
      },
      "regions": [
        {
          "type": "text",
          "text": "Adaptation measures include drought resistant seed varieties",
          "page": 14,
          "bbox": {
            "x": 0.16,
            "y": 0.19,
            "width": 0.68,
            "height": 0.06
          },
          "confidence": "high"
        }
      ],
      "custom_metadata": {
        "review_status": "peer_reviewed",
        "topic": "adaptation"
      },
      "metadata": {
        "section": "Adaptation strategies"
      }
    }
  ],
  "cursor": 0,
  "next_cursor": 2,
  "warnings": [
    "warnings"
  ]
}

List chunks for a document with pagination and optional regions or metadata.

Path parameters

collection_namestringRequired

Query parameters

document_idstringRequired

limitintegerOptional1-500Defaults to 100

cursorintegerOptional>=0Defaults to 0

include_regionsbooleanOptionalDefaults to false

include_metadatabooleanOptionalDefaults to true

Response

List Chunks response.

collection_namestring

document_idstring

total_resultsinteger

limitinteger

chunkslist of objects

cursorintegerDefaults to 0

next_cursorinteger

warningslist of strings

Errors

401

List Chunks V3request Unauthorized Error

403

List Chunks V3request Forbidden Error

404

List Chunks V3request Not Found Error