Vapi · Schema

ResponseTextDeltaEvent

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
content_index number Index of the content part
delta string Text delta being added
item_id string ID of the output item
output_index number Index of the output item
type string Event type
View JSON Schema on GitHub

JSON Schema

vapi-responsetextdeltaevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResponseTextDeltaEvent",
  "title": "ResponseTextDeltaEvent",
  "type": "object",
  "properties": {
    "content_index": {
      "type": "number",
      "description": "Index of the content part"
    },
    "delta": {
      "type": "string",
      "description": "Text delta being added"
    },
    "item_id": {
      "type": "string",
      "description": "ID of the output item"
    },
    "output_index": {
      "type": "number",
      "description": "Index of the output item"
    },
    "type": {
      "type": "string",
      "default": "response.output_text.delta",
      "description": "Event type",
      "enum": [
        "response.output_text.delta"
      ]
    }
  },
  "required": [
    "content_index",
    "delta",
    "item_id",
    "output_index",
    "type"
  ]
}