> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vocobase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a dictionary

> Creates a new speech-recognition dictionary for the partner. Terms are normalized server-side: whitespace is trimmed, empty/whitespace-only entries are dropped, non-string entries are silently skipped, and the dedupe is case-insensitive but preserves first-occurrence casing. A blank `description` is stored as `null`. Dictionary names must be unique per partner.



## OpenAPI

````yaml /openapi.json post /dictionaries
openapi: 3.1.0
info:
  title: Vocobase Partner API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update partner configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
paths:
  /dictionaries:
    post:
      tags:
        - Dictionaries
      summary: Create a dictionary
      description: >-
        Creates a new speech-recognition dictionary for the partner. Terms are
        normalized server-side: whitespace is trimmed, empty/whitespace-only
        entries are dropped, non-string entries are silently skipped, and the
        dedupe is case-insensitive but preserves first-occurrence casing. A
        blank `description` is stored as `null`. Dictionary names must be unique
        per partner.
      operationId: createDictionary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: Unique dictionary name (per partner).
                description:
                  type:
                    - string
                    - 'null'
                  maxLength: 500
                  description: Optional description. Blank strings are stored as null.
                terms:
                  type: array
                  items:
                    type: string
                  description: >-
                    Optional list of terms. Defaults to []. Normalized
                    server-side.
            example:
              name: Vocobase Product Catalog
              description: Product names, SKUs, and plan tiers referenced on support calls.
              terms:
                - Vocobase
                - SKU-4471
                - Pro Annual Plan
                - Voice Sandbox
                - Meera Iyer
      responses:
        '201':
          description: Dictionary created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/Dictionary'
              example:
                success: true
                data:
                  id: d1234567-abcd-1234-abcd-123456789012
                  name: Vocobase Product Catalog
                  description: >-
                    Product names, SKUs, and plan tiers referenced on support
                    calls.
                  terms:
                    - Vocobase
                    - SKU-4471
                    - Pro Annual Plan
                    - Voice Sandbox
                    - Meera Iyer
                  term_count: 5
                  char_count: 52
                  attached_agent_count: 0
                  created_at: '2026-04-24T10:30:00.000Z'
                  updated_at: '2026-04-24T10:30:00.000Z'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Dictionary name already taken by this partner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: DICTIONARY_NAME_TAKEN
                  message: A dictionary with this name already exists.
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Dictionary:
      allOf:
        - $ref: '#/components/schemas/DictionarySummary'
        - type: object
          properties:
            terms:
              type: array
              items:
                type: string
              description: >-
                Normalized list of terms (whitespace-trimmed, case-insensitively
                deduped, non-string entries dropped).
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
    DictionarySummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        term_count:
          type: integer
          description: Number of unique terms after normalization.
        char_count:
          type: integer
          description: Total characters across all terms.
        attached_agent_count:
          type: integer
          description: Number of agents this dictionary is currently attached to.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  responses:
    ValidationError:
      description: Validation error in request body or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: VALIDATION_ERROR
              message: agent_name is required and must be max 50 characters
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````