---
title: "List Chunks"
method: GET
path: "/v3/collections/{collection_name}/chunks"
tags: ["file-search"]
---

# List Chunks

`GET /v3/collections/{collection_name}/chunks`

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

## Path parameters

- `collection_name` string, required

## Query parameters

- `document_id` string, required
- `limit` integer
- `cursor` integer
- `include_regions` boolean
- `include_metadata` boolean

## Response `200`

List Chunks response.

- ListChunksResponseV3
  - `collection_name` string, required
  - `document_id` string, required
  - `chunks` DocumentChunkV3[]
    - `chunk_id` string, required
    - `document_id` string, required
    - `text` string, required
    - `location` FileSearchLocationFromV3
      - `page_start` integer, nullable
      - `page_end` integer, nullable
      - `chunk_index` integer, nullable
      - `parent_chunk_index` integer, nullable
      - `start_seconds` number, double, nullable
      - `end_seconds` number, double, nullable
      - `sheet_name` string, nullable
      - `row_start` integer, nullable
      - `row_end` integer, nullable
      - `col_start` integer, nullable
      - `col_end` integer, nullable
    - `regions` FileSearchRegionFromV3[], nullable
      - `type` string, nullable — Region category, such as `text`, `title`, `section_header`, `key_value`, `table`, `figure`, `chart`, or `image`. Regions of type `figure`, `chart`, or `image` also carry a cropped `image_url` (a visual citation).
      - `text` string, nullable
      - `page` integer, nullable
      - `bbox` object, nullable
      - `confidence` string, nullable
      - `image_url` string, nullable — Short-lived presigned URL to a cropped image of the region (a visual citation), returned for `figure`, `chart`, and `image` regions when `include.regions` is true. Null for text regions and for documents indexed before figure cropping was enabled. Fetch promptly — the link expires within minutes.
      - `description` string, nullable
    - `custom_metadata` DocumentChunkV3CustomMetadata
    - `metadata` DocumentChunkV3Metadata
    - `chunk_type` 'body' | 'table' | 'heading' | 'page_header' | 'page_footer' | 'footnote' | 'figure' — Layout role of this chunk, classified from the parser's block structure at indexing time: body, table, heading, page_header, page_footer, footnote, or figure. Null when the chunk has no label: content indexed before chunk types shipped, plain-text and media content, or regions the parser returned without block structure. Treat unknown future values as additive.
  - `total_results` integer, required
  - `limit` integer, required
  - `cursor` integer
  - `next_cursor` integer, nullable
  - `warnings` string[]

## Other responses

- `401` — Missing or invalid authentication.
- `403` — Collection is inactive.
- `404` — Collection not found.

---

[API](https://skmtc.dev/runcaptain/apis/api-reference.md) · [All operations](https://skmtc.dev/runcaptain/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runcaptain/api-reference/revisions/fe4649e3f4aa/schema)