Skip to content

List documents

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

List documents with pagination and optional search. Documents are the source content from which memory units are extracted.

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

Path Parameters

NameTypeRequiredDescription
bank_idstringYes

Query Parameters

NameTypeRequiredDescription
qstring | nullNoCase-insensitive substring filter on document ID (e.g. 'report' matches 'report-2024')
tagsstring[] | nullNoFilter documents by tags
tags_matchstringNoHow to match tags: 'any', 'all', 'any_strict', 'all_strict'
limitintegerNo
offsetintegerNo

Example Request

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

Responses

200 — Successful Response

json
{
  "items": [
    {
      "bank_id": "user123",
      "content_hash": "abc123",
      "created_at": "2024-01-15T10:30:00Z",
      "id": "session_1",
      "memory_unit_count": 15,
      "tags": [
        "user_a",
        "session_123"
      ],
      "text_length": 5420,
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "limit": 100,
  "offset": 0,
  "total": 50
}

422 — Validation Error

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

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