Vapi · Schema

CreateWebCallDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
roomDeleteOnUserLeaveEnabled	boolean
assistantId	string	This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead. To start a call with: - Assistant, use `assistantId` or `assistant` - Squad, use `squadI
assistant	object	This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. To start a call with: - Assistant, use `assistant` - Squad, use `squad` - Workflow, use `
assistantOverrides	object	These are the overrides for the `assistant` or `assistantId`'s settings and template variables.
squadId	string	This is the squad that will be used for the call. To use a transient squad, use `squad` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` -
squad	object	This is a squad that will be used for the call. To use an existing squad, use `squadId` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` -
squadOverrides	object	These are the overrides for the `squad` or `squadId`'s member settings and template variables. This will apply to all members of the squad.
workflowId	string	This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `s
workflow	object	This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `s
workflowOverrides	object	These are the overrides for the `workflow` or `workflowId`'s settings and template variables.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateWebCallDTO",
  "title": "CreateWebCallDTO",
  "type": "object",
  "properties": {
    "roomDeleteOnUserLeaveEnabled": {
      "type": "boolean",
      "default": true
    },
    "assistantId": {
      "type": "string",
      "description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
    },
    "assistant": {
      "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nTo start a call with:\n- Assistant, use `assistant`\n- Squad, use `squad`\n- Workflow, use `workflow`",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateAssistantDTO"
        }
      ]
    },
    "assistantOverrides": {
      "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AssistantOverrides"
        }
      ]
    },
    "squadId": {
      "type": "string",
      "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
    },
    "squad": {
      "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateSquadDTO"
        }
      ]
    },
    "squadOverrides": {
      "description": "These are the overrides for the `squad` or `squadId`'s member settings and template variables.\nThis will apply to all members of the squad.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AssistantOverrides"
        }
      ]
    },
    "workflowId": {
      "type": "string",
      "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
    },
    "workflow": {
      "description": "This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateWorkflowDTO"
        }
      ]
    },
    "workflowOverrides": {
      "description": "These are the overrides for the `workflow` or `workflowId`'s settings and template variables.",
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowOverrides"
        }
      ]
    }
  }
}