Skip to content

List directives

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

List hard rules that are injected into prompts.

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

Path Parameters

NameTypeRequiredDescription
bank_idstringYes

Query Parameters

NameTypeRequiredDescription
tagsstring[] | nullNoFilter by tags
tags_matchenum("any", "all", "exact")NoHow to match tags
active_onlybooleanNoOnly return active directives
limitintegerNo
offsetintegerNo

Example Request

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

Responses

200 — Successful Response

json
{
  "items": [
    {
      "id": "Id",
      "bank_id": "Bank Id",
      "name": "Name",
      "content": "Content",
      "priority": 0,
      "is_active": true,
      "tags": [],
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

422 — Validation Error

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

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