Vapi · Schema

Squad

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
name	string	This is the name of the squad.
members	array	This is the list of assistants that make up the squad. The call will start with the first assistant in the list.
membersOverrides	object	This can be used to override all the assistants' settings and provide values for their template variables. Both `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `mem
id	string	This is the unique identifier for the squad.
orgId	string	This is the unique identifier for the org that this squad belongs to.
createdAt	string	This is the ISO 8601 date-time string of when the squad was created.
updatedAt	string	This is the ISO 8601 date-time string of when the squad was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Squad",
  "title": "Squad",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is the name of the squad."
    },
    "members": {
      "description": "This is the list of assistants that make up the squad.\n\nThe call will start with the first assistant in the list.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SquadMemberDTO"
      }
    },
    "membersOverrides": {
      "description": "This can be used to override all the assistants' settings and provide values for their template variables.\n\nBoth `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AssistantOverrides"
        }
      ]
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the squad."
    },
    "orgId": {
      "type": "string",
      "description": "This is the unique identifier for the org that this squad belongs to."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the squad was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the squad was last updated."
    }
  },
  "required": [
    "members",
    "id",
    "orgId",
    "createdAt",
    "updatedAt"
  ]
}