Vapi · Schema

SimulationRunItemMetadata

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
assistant object This is a snapshot of the assistant at run creation time.
squad object This is a snapshot of the squad at run creation time.
scenario object This is a snapshot of the scenario at run creation time.
personality object This is a snapshot of the personality at run creation time.
simulation object This is a snapshot of the simulation at run creation time.
call object This is the call-related data (transcript, messages, recording).
hooks object Hook execution state for this run item (used for idempotency + debugging).
View JSON Schema on GitHub

JSON Schema

vapi-simulationrunitemmetadata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SimulationRunItemMetadata",
  "title": "SimulationRunItemMetadata",
  "type": "object",
  "properties": {
    "assistant": {
      "type": "object",
      "description": "This is a snapshot of the assistant at run creation time.",
      "additionalProperties": true
    },
    "squad": {
      "type": "object",
      "description": "This is a snapshot of the squad at run creation time.",
      "additionalProperties": true
    },
    "scenario": {
      "type": "object",
      "description": "This is a snapshot of the scenario at run creation time.",
      "additionalProperties": true
    },
    "personality": {
      "type": "object",
      "description": "This is a snapshot of the personality at run creation time.",
      "additionalProperties": true
    },
    "simulation": {
      "type": "object",
      "description": "This is a snapshot of the simulation at run creation time.",
      "additionalProperties": true
    },
    "call": {
      "description": "This is the call-related data (transcript, messages, recording).",
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationRunItemCallMetadata"
        }
      ]
    },
    "hooks": {
      "type": "object",
      "description": "Hook execution state for this run item (used for idempotency + debugging).",
      "additionalProperties": true
    }
  }
}