Vapi · Schema

Personality

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
id string This is the unique identifier for the personality.
orgId string This is the unique identifier for the organization this personality belongs to. If null, this is a Vapi-provided default personality available to all organizations.
createdAt string This is the ISO 8601 date-time string of when the personality was created.
updatedAt string This is the ISO 8601 date-time string of when the personality was last updated.
name string This is the name of the personality (e.g., "Confused Carl", "Rude Rob").
assistant object This is the full assistant configuration for this personality. It defines the tester's voice, model, behavior via system prompt, and other settings.
path string Optional folder path for organizing personalities. Supports up to 3 levels (e.g., "dept/feature/variant"). Maps to GitOps resource folder structure.
View JSON Schema on GitHub

JSON Schema

vapi-personality-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Personality",
  "title": "Personality",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the personality.",
      "format": "uuid"
    },
    "orgId": {
      "type": "string",
      "nullable": true,
      "description": "This is the unique identifier for the organization this personality belongs to.\nIf null, this is a Vapi-provided default personality available to all organizations.",
      "format": "uuid"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the personality was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the personality was last updated."
    },
    "name": {
      "type": "string",
      "description": "This is the name of the personality (e.g., \"Confused Carl\", \"Rude Rob\").",
      "maxLength": 80
    },
    "assistant": {
      "description": "This is the full assistant configuration for this personality.\nIt defines the tester's voice, model, behavior via system prompt, and other settings.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateAssistantDTO"
        }
      ]
    },
    "path": {
      "type": "string",
      "nullable": true,
      "description": "Optional folder path for organizing personalities.\nSupports up to 3 levels (e.g., \"dept/feature/variant\").\nMaps to GitOps resource folder structure.",
      "maxLength": 255,
      "pattern": "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"
    }
  },
  "required": [
    "id",
    "orgId",
    "createdAt",
    "updatedAt",
    "name",
    "assistant"
  ]
}

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-personality"
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 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.

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