Skip to content

Update document

PATCH /v1/default/banks/{bank_id}/documents/{document_id}

Update mutable fields on a document without re-processing its content.

Tags (tags): Propagated to all associated memory units. Observations derived from those units are invalidated and queued for re-consolidation under the new tags. Co-source memories from other documents that shared those observations are also reset.

At least one field must be provided.

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

Path Parameters

NameTypeRequiredDescription
bank_idstringYes
document_idstringYes

Request Body

Content-Type: application/json

json
{
  "tags": [
    "team-a",
    "team-b"
  ]
}

Example Request

bash
curl -X PATCH 'https://api.hindsight.vectorize.io/v1/default/banks/your-bank-id/documents/your-document-id' \
  -H 'Authorization: Bearer hsk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "tags": [
      "team-a",
      "team-b"
    ]
  }'

Responses

200 — Successful Response

json
{
  "success": true
}

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}