Vapi · JSON Structure

Vapi Assistant Structure

Type: object Properties: 30
Artificial IntelligenceVoice AIVoice AgentsConversational AITelephonyReal-TimeTranscriptionText-to-SpeechLLMAgentsMCP

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

Properties

transcriber model voice firstMessage firstMessageInterruptionsEnabled firstMessageMode voicemailDetection clientMessages serverMessages maxDurationSeconds backgroundSound modelOutputInMessagesEnabled transportConfigurations observabilityPlan credentials hooks name voicemailMessage endCallMessage endCallPhrases compliancePlan metadata backgroundSpeechDenoisingPlan analysisPlan artifactPlan startSpeakingPlan stopSpeakingPlan monitorPlan credentialIds server

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "Assistant",
  "type": "object",
  "properties": {
    "transcriber": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "firstMessage": {
      "type": "string"
    },
    "firstMessageInterruptionsEnabled": {
      "type": "boolean"
    },
    "firstMessageMode": {
      "type": "string"
    },
    "voicemailDetection": {
      "type": "string"
    },
    "clientMessages": {
      "type": "array"
    },
    "serverMessages": {
      "type": "array"
    },
    "maxDurationSeconds": {
      "type": "number"
    },
    "backgroundSound": {
      "type": "string"
    },
    "modelOutputInMessagesEnabled": {
      "type": "boolean"
    },
    "transportConfigurations": {
      "type": "array"
    },
    "observabilityPlan": {
      "type": "string"
    },
    "credentials": {
      "type": "array"
    },
    "hooks": {
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "voicemailMessage": {
      "type": "string"
    },
    "endCallMessage": {
      "type": "string"
    },
    "endCallPhrases": {
      "type": "array"
    },
    "compliancePlan": {
      "type": "object"
    },
    "metadata": {
      "type": "object"
    },
    "backgroundSpeechDenoisingPlan": {
      "type": "string"
    },
    "analysisPlan": {
      "type": "string"
    },
    "artifactPlan": {
      "type": "string"
    },
    "startSpeakingPlan": {
      "type": "string"
    },
    "stopSpeakingPlan": {
      "type": "string"
    },
    "monitorPlan": {
      "type": "string"
    },
    "credentialIds": {
      "type": "array"
    },
    "server": {
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure 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 Structure 
curl "https://apis.io/api/v1/json-structures/vapi-assistant-structure"
All json structure 
curl "https://apis.io/api/v1/json-structures?limit=25"

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

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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