Vapi · Schema

WorkflowCustomModel

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
provider string This is the provider of the model (`custom-llm`).
metadataSendMode string This determines whether metadata is sent in requests to the custom provider. - `off` will not send any metadata. payload will look like `{ messages }` - `variable` will send `assistant.metadata` as a
url string These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1
headers object These are the headers we'll use for the OpenAI client's `headers`.
timeoutSeconds number This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds.
model string This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
temperature number This is the temperature of the model.
maxTokens number This is the max tokens of the model.
View JSON Schema on GitHub

JSON Schema

vapi-workflowcustommodel-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkflowCustomModel",
  "title": "WorkflowCustomModel",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "description": "This is the provider of the model (`custom-llm`).",
      "enum": [
        "custom-llm"
      ]
    },
    "metadataSendMode": {
      "type": "string",
      "description": "This determines whether metadata is sent in requests to the custom provider.\n\n- `off` will not send any metadata. payload will look like `{ messages }`\n- `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }`\n- `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }`\n\nFurther, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload.\n\nDefault is `variable`.",
      "enum": [
        "off",
        "variable",
        "destructured"
      ]
    },
    "url": {
      "type": "string",
      "description": "These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1"
    },
    "headers": {
      "type": "object",
      "description": "These are the headers we'll use for the OpenAI client's `headers`."
    },
    "timeoutSeconds": {
      "type": "number",
      "description": "This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds.",
      "minimum": 20,
      "maximum": 600
    },
    "model": {
      "type": "string",
      "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
      "maxLength": 100
    },
    "temperature": {
      "type": "number",
      "description": "This is the temperature of the model.",
      "minimum": 0,
      "maximum": 2
    },
    "maxTokens": {
      "type": "number",
      "description": "This is the max tokens of the model.",
      "minimum": 50,
      "maximum": 10000
    }
  },
  "required": [
    "provider",
    "url",
    "model"
  ]
}

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