List attached dictionaries

GET

agent

{id}

dictionaries

curl --request GET \
  --url https://api.vocobase.com/api/v2/agent/{id}/dictionaries \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "dictionaries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "term_count": 123,
        "char_count": 123,
        "attached_agent_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

string<uuid>

required

Agent ID.

Response

List of attached dictionaries.

success

boolean

data

object

Show child attributes

Replace the agent's attached dictionariesIdempotent set-replace: overwrites the agent's entire dictionary set with `dictionary_ids`. Duplicate ids are deduped silently. Every id must exist and belong to the calling partner, else the whole request fails with `VALIDATION_ERROR`. The combined `char_count` across the resulting set must be at most 10,000 characters; otherwise the request fails with `DICTIONARY_CHAR_LIMIT_EXCEEDED`. Pass `[]` to detach all dictionaries. The swap is wrapped in a transaction -- the attached set is never briefly partial.

List attached dictionaries

curl --request GET \
  --url https://api.vocobase.com/api/v2/agent/{id}/dictionaries \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "dictionaries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "term_count": 123,
        "char_count": 123,
        "attached_agent_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}