Skip to content

List document chunks

GET /v1/default/banks/{bank_id}/documents/{document_id}/chunks

List all chunks for a given document, ordered by chunk index.

Authentication required — include an Authorization: Bearer hsk_... header. See Authentication for details.

Path Parameters

NameTypeRequiredDescription
bank_idstringYes
document_idstringYes

Query Parameters

NameTypeRequiredDescription
limitintegerNoMaximum number of chunks to return
offsetintegerNoOffset for pagination

Example Request

bash
curl -X GET 'https://api.hindsight.vectorize.io/v1/default/banks/your-bank-id/documents/your-document-id/chunks' \
  -H 'Authorization: Bearer hsk_your_api_key'

Responses

200 — Successful Response

json
{
  "items": [
    {
      "bank_id": "user123",
      "chunk_id": "user123_session_1_0",
      "chunk_index": 0,
      "chunk_text": "This is the first chunk of the document...",
      "created_at": "2024-01-15T10:30:00Z",
      "document_id": "session_1"
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0
}

422 — Validation Error

json
{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "Message",
      "type": "Error Type",
      "input": null,
      "ctx": {},
      "url": "URL"
    }
  ]
}

Source: /v1/default/banks/{bank_id}/documents/{document_id}/chunks