Vapi · Schema

SimulationRunSimulationEntry

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
type string Type discriminator
simulationId string ID of an existing simulation to run. When provided, scenarioId/personalityId/inline fields are ignored.
scenarioId string ID of an existing scenario. Cannot be combined with inline scenario.
scenario object Inline scenario configuration. Cannot be combined with scenarioId.
personalityId string ID of an existing personality. Cannot be combined with inline personality.
personality object Inline personality configuration. Cannot be combined with personalityId.
name string Optional name for this simulation entry
View JSON Schema on GitHub

JSON Schema

vapi-simulationrunsimulationentry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SimulationRunSimulationEntry",
  "title": "SimulationRunSimulationEntry",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "simulation"
      ],
      "description": "Type discriminator"
    },
    "simulationId": {
      "type": "string",
      "description": "ID of an existing simulation to run. When provided, scenarioId/personalityId/inline fields are ignored.",
      "format": "uuid"
    },
    "scenarioId": {
      "type": "string",
      "description": "ID of an existing scenario. Cannot be combined with inline scenario.",
      "format": "uuid"
    },
    "scenario": {
      "description": "Inline scenario configuration. Cannot be combined with scenarioId.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateScenarioDTO"
        }
      ]
    },
    "personalityId": {
      "type": "string",
      "description": "ID of an existing personality. Cannot be combined with inline personality.",
      "format": "uuid"
    },
    "personality": {
      "description": "Inline personality configuration. Cannot be combined with personalityId.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatePersonalityDTO"
        }
      ]
    },
    "name": {
      "type": "string",
      "maxLength": 80,
      "description": "Optional name for this simulation entry"
    }
  },
  "required": [
    "type"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vapi-simulationrunsimulationentry"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.