Agents

Replace the agent's attached dictionaries

Idempotent 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.

PUT

agent

{id}

dictionaries

Replace the agent's attached dictionaries

curl --request PUT \
  --url https://api.vocobase.com/api/v2/agent/{id}/dictionaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dictionary_ids": [
    "d1234567-abcd-1234-abcd-123456789012"
  ]
}
'

{
  "success": true,
  "data": {
    "dictionaries": [
      {
        "id": "d1234567-abcd-1234-abcd-123456789012",
        "name": "Vocobase Product Catalog",
        "term_count": 5,
        "char_count": 52,
        "attached_agent_count": 1,
        "created_at": "2026-04-24T10:30:00.000Z",
        "updated_at": "2026-04-24T10:30:00.000Z"
      }
    ]
  }
}

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.

Body

application/json

dictionary_ids

string<uuid>[]

required

Full replacement set of dictionary IDs. Pass [] to detach all.

Response

Agent's attached dictionaries after the swap.

success

boolean

data

object

Show child attributes

List available voicesReturns the voices available to this partner, filtered from the Cartesia voice catalog. Optionally filter by language.

Replace the agent's attached dictionaries

curl --request PUT \
  --url https://api.vocobase.com/api/v2/agent/{id}/dictionaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dictionary_ids": [
    "d1234567-abcd-1234-abcd-123456789012"
  ]
}
'

{
  "success": true,
  "data": {
    "dictionaries": [
      {
        "id": "d1234567-abcd-1234-abcd-123456789012",
        "name": "Vocobase Product Catalog",
        "term_count": 5,
        "char_count": 52,
        "attached_agent_count": 1,
        "created_at": "2026-04-24T10:30:00.000Z",
        "updated_at": "2026-04-24T10:30:00.000Z"
      }
    ]
  }
}

Getting Started

Guides

Partner Onboarding

API Reference

Webhooks

Telephony

Replace the agent's attached dictionaries

Authorizations

Path Parameters

Body

Response