Vapi · Schema

HandoffDestinationSquad

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
type string
contextEngineeringPlan object This is the plan for manipulating the message context before handing off the call to the squad.
squadId string This is the squad id to transfer the call to.
squad object This is a transient squad to transfer the call to.
entryAssistantName string This is the name of the entry assistant to start with when handing off to the squad. If not provided, the first member of the squad will be used.
variableExtractionPlan object This is the variable extraction plan for the handoff tool.
squadOverrides object These are the overrides to apply to the squad configuration. Maps to squad-level membersOverrides.
description string This is the description of the destination, used by the AI to choose when and how to transfer the call.
View JSON Schema on GitHub

JSON Schema

vapi-handoffdestinationsquad-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HandoffDestinationSquad",
  "title": "HandoffDestinationSquad",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "squad"
      ]
    },
    "contextEngineeringPlan": {
      "description": "This is the plan for manipulating the message context before handing off the call to the squad.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/ContextEngineeringPlanLastNMessages",
          "title": "Last N Messages"
        },
        {
          "$ref": "#/components/schemas/ContextEngineeringPlanNone",
          "title": "None"
        },
        {
          "$ref": "#/components/schemas/ContextEngineeringPlanAll",
          "title": "All"
        },
        {
          "$ref": "#/components/schemas/ContextEngineeringPlanUserAndAssistantMessages",
          "title": "User And Assistant Messages"
        },
        {
          "$ref": "#/components/schemas/ContextEngineeringPlanPreviousAssistantMessages",
          "title": "Previous Assistant Messages"
        }
      ]
    },
    "squadId": {
      "type": "string",
      "description": "This is the squad id to transfer the call to."
    },
    "squad": {
      "description": "This is a transient squad to transfer the call to.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateSquadDTO"
        }
      ]
    },
    "entryAssistantName": {
      "type": "string",
      "description": "This is the name of the entry assistant to start with when handing off to the squad.\nIf not provided, the first member of the squad will be used."
    },
    "variableExtractionPlan": {
      "description": "This is the variable extraction plan for the handoff tool.",
      "allOf": [
        {
          "$ref": "#/components/schemas/VariableExtractionPlan"
        }
      ]
    },
    "squadOverrides": {
      "description": "These are the overrides to apply to the squad configuration.\nMaps to squad-level membersOverrides.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AssistantOverrides"
        }
      ]
    },
    "description": {
      "type": "string",
      "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
    }
  },
  "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-handoffdestinationsquad"
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.