Vapi · JSON Structure

Vapi Chat Structure

Type: object Properties: 18
AIVoice AIVoice AgentsConversational AITelephonyReal-TimeTranscriptionText-to-SpeechLLMAgentsMCP

Chat is a JSON Structure definition published by Vapi, describing 18 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

assistantId assistant assistantOverrides squadId squad name sessionId input stream previousChatId id orgId messages output createdAt updatedAt costs cost

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "Chat",
  "type": "object",
  "properties": {
    "assistantId": {
      "type": "string"
    },
    "assistant": {
      "type": "string"
    },
    "assistantOverrides": {
      "type": "string"
    },
    "squadId": {
      "type": "string"
    },
    "squad": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "sessionId": {
      "type": "string"
    },
    "input": {
      "type": "string"
    },
    "stream": {
      "type": "boolean"
    },
    "previousChatId": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "orgId": {
      "type": "string"
    },
    "messages": {
      "type": "array"
    },
    "output": {
      "type": "array"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "costs": {
      "type": "array"
    },
    "cost": {
      "type": "number"
    }
  }
}