Vapi · JSON Structure

Vapi Session Structure

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

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

Properties

id orgId createdAt updatedAt cost costs name status expirationSeconds assistantId assistant assistantOverrides squadId squad messages customer customerId phoneNumberId phoneNumber artifact

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "Session",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "orgId": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "cost": {
      "type": "number"
    },
    "costs": {
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "expirationSeconds": {
      "type": "number"
    },
    "assistantId": {
      "type": "string"
    },
    "assistant": {
      "type": "string"
    },
    "assistantOverrides": {
      "type": "string"
    },
    "squadId": {
      "type": "string"
    },
    "squad": {
      "type": "string"
    },
    "messages": {
      "type": "array"
    },
    "customer": {
      "type": "string"
    },
    "customerId": {
      "type": "string"
    },
    "phoneNumberId": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "artifact": {
      "type": "string"
    }
  }
}