Vapi · Schema

CartesiaPronunciationDictionary

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
id string Unique identifier for the pronunciation dictionary
name string Name of the pronunciation dictionary
ownerId string ID of the user who owns this dictionary
pinned boolean Whether this dictionary is pinned for the user
items array List of text-to-pronunciation mappings
createdAt string ISO 8601 timestamp of when the dictionary was created
View JSON Schema on GitHub

JSON Schema

vapi-cartesiapronunciationdictionary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CartesiaPronunciationDictionary",
  "title": "CartesiaPronunciationDictionary",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the pronunciation dictionary",
      "example": "dict_abc123"
    },
    "name": {
      "type": "string",
      "description": "Name of the pronunciation dictionary",
      "example": "My Dictionary"
    },
    "ownerId": {
      "type": "string",
      "description": "ID of the user who owns this dictionary",
      "example": "user_xyz789"
    },
    "pinned": {
      "type": "boolean",
      "description": "Whether this dictionary is pinned for the user",
      "example": false
    },
    "items": {
      "description": "List of text-to-pronunciation mappings",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CartesiaPronunciationDictItem"
      }
    },
    "createdAt": {
      "type": "string",
      "description": "ISO 8601 timestamp of when the dictionary was created",
      "example": "2024-01-15T10:30:00Z"
    }
  },
  "required": [
    "id",
    "name",
    "ownerId",
    "pinned",
    "items",
    "createdAt"
  ]
}