POST
/
call
curl --request POST \
  --url https://api.vapi.ai/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "assistantId": "<string>",
  "assistant": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "bg",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant"
        }
      ],
      "tools": [
        {
          "async": true,
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": "<string>",
                  "operator": "eq"
                }
              ]
            }
          ],
          "type": "dtmf",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          },
          "server": {
            "timeoutSeconds": 20,
            "url": "<string>",
            "secret": "<string>"
          }
        }
      ],
      "toolIds": [
        "<string>"
      ],
      "provider": "anyscale",
      "model": "<string>",
      "temperature": 1,
      "knowledgeBase": {
        "provider": "canonical",
        "topK": 5.5,
        "fileIds": [
          "<string>"
        ]
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputPreprocessingEnabled": true,
      "inputReformattingEnabled": true,
      "inputMinCharacters": 30,
      "inputPunctuationBoundaries": [
        "。",
        ",",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "firstMessageMode": "assistant-speaks-first",
    "recordingEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "conversation-update",
      "function-call",
      "hang",
      "model-output",
      "speech-update",
      "status-update",
      "transcript",
      "tool-calls",
      "user-interrupted",
      "voice-input"
    ],
    "serverMessages": [
      "conversation-update",
      "end-of-call-report",
      "function-call",
      "hang",
      "speech-update",
      "status-update",
      "tool-calls",
      "transfer-destination-request",
      "user-interrupted"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "llmRequestNonPunctuatedDelaySeconds": 1.5,
    "numWordsToInterruptAssistant": 5,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "backgroundDenoisingEnabled": true,
    "modelOutputInMessagesEnabled": true,
    "transportConfigurations": [
      {
        "provider": "twilio",
        "timeout": 60,
        "record": true,
        "recordingChannels": "mono"
      }
    ],
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetection": {
      "provider": "twilio",
      "voicemailDetectionTypes": [
        "machine_end_beep",
        "machine_end_silence"
      ],
      "enabled": true,
      "machineDetectionTimeout": 31,
      "machineDetectionSpeechThreshold": 3500,
      "machineDetectionSpeechEndThreshold": 2750,
      "machineDetectionSilenceTimeout": 6000
    },
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "analysisPlan": {
      "summaryPrompt": "<string>",
      "summaryRequestTimeoutSeconds": 10.5,
      "structuredDataRequestTimeoutSeconds": 10.5,
      "successEvaluationPrompt": "<string>",
      "successEvaluationRubric": "NumericScale",
      "successEvaluationRequestTimeoutSeconds": 10.5,
      "structuredDataPrompt": "<string>",
      "structuredDataSchema": {
        "type": "string",
        "items": {},
        "properties": {},
        "description": "<string>",
        "required": [
          "<string>"
        ]
      }
    },
    "artifactPlan": {
      "videoRecordingEnabled": true
    },
    "messagePlan": {
      "idleMessages": [
        "<string>"
      ],
      "idleMessageMaxSpokenCount": 5.5,
      "idleTimeoutSeconds": 17.5
    }
  },
  "assistantOverrides": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "bg",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant"
        }
      ],
      "tools": [
        {
          "async": true,
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": "<string>",
                  "operator": "eq"
                }
              ]
            }
          ],
          "type": "dtmf",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          },
          "server": {
            "timeoutSeconds": 20,
            "url": "<string>",
            "secret": "<string>"
          }
        }
      ],
      "toolIds": [
        "<string>"
      ],
      "provider": "anyscale",
      "model": "<string>",
      "temperature": 1,
      "knowledgeBase": {
        "provider": "canonical",
        "topK": 5.5,
        "fileIds": [
          "<string>"
        ]
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputPreprocessingEnabled": true,
      "inputReformattingEnabled": true,
      "inputMinCharacters": 30,
      "inputPunctuationBoundaries": [
        "。",
        ",",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "firstMessageMode": "assistant-speaks-first",
    "recordingEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "conversation-update",
      "function-call",
      "hang",
      "model-output",
      "speech-update",
      "status-update",
      "transcript",
      "tool-calls",
      "user-interrupted",
      "voice-input"
    ],
    "serverMessages": [
      "conversation-update",
      "end-of-call-report",
      "function-call",
      "hang",
      "speech-update",
      "status-update",
      "tool-calls",
      "transfer-destination-request",
      "user-interrupted"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "llmRequestNonPunctuatedDelaySeconds": 1.5,
    "numWordsToInterruptAssistant": 5,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "backgroundDenoisingEnabled": true,
    "modelOutputInMessagesEnabled": true,
    "transportConfigurations": [
      {
        "provider": "twilio",
        "timeout": 60,
        "record": true,
        "recordingChannels": "mono"
      }
    ],
    "variableValues": {},
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetection": {
      "provider": "twilio",
      "voicemailDetectionTypes": [
        "machine_end_beep",
        "machine_end_silence"
      ],
      "enabled": true,
      "machineDetectionTimeout": 31,
      "machineDetectionSpeechThreshold": 3500,
      "machineDetectionSpeechEndThreshold": 2750,
      "machineDetectionSilenceTimeout": 6000
    },
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "analysisPlan": {
      "summaryPrompt": "<string>",
      "summaryRequestTimeoutSeconds": 10.5,
      "structuredDataRequestTimeoutSeconds": 10.5,
      "successEvaluationPrompt": "<string>",
      "successEvaluationRubric": "NumericScale",
      "successEvaluationRequestTimeoutSeconds": 10.5,
      "structuredDataPrompt": "<string>",
      "structuredDataSchema": {
        "type": "string",
        "items": {},
        "properties": {},
        "description": "<string>",
        "required": [
          "<string>"
        ]
      }
    },
    "artifactPlan": {
      "videoRecordingEnabled": true
    },
    "messagePlan": {
      "idleMessages": [
        "<string>"
      ],
      "idleMessageMaxSpokenCount": 5.5,
      "idleTimeoutSeconds": 17.5
    }
  },
  "squadId": "<string>",
  "squad": {
    "name": "<string>",
    "members": [
      {
        "assistantId": "<string>",
        "assistant": {
          "transcriber": {
            "provider": "deepgram",
            "model": "nova-2",
            "language": "bg",
            "smartFormat": true,
            "keywords": [
              "<string>"
            ]
          },
          "model": {
            "messages": [
              {
                "content": "<string>",
                "role": "assistant"
              }
            ],
            "tools": [
              {
                "async": true,
                "messages": [
                  {
                    "type": "request-start",
                    "content": "<string>",
                    "conditions": [
                      {
                        "param": "<string>",
                        "value": "<string>",
                        "operator": "eq"
                      }
                    ]
                  }
                ],
                "type": "dtmf",
                "function": {
                  "name": "<string>",
                  "description": "<string>",
                  "parameters": {
                    "type": "object",
                    "properties": {},
                    "required": [
                      "<string>"
                    ]
                  }
                },
                "server": {
                  "timeoutSeconds": 20,
                  "url": "<string>",
                  "secret": "<string>"
                }
              }
            ],
            "toolIds": [
              "<string>"
            ],
            "provider": "anyscale",
            "model": "<string>",
            "temperature": 1,
            "knowledgeBase": {
              "provider": "canonical",
              "topK": 5.5,
              "fileIds": [
                "<string>"
              ]
            },
            "maxTokens": 525,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "inputPreprocessingEnabled": true,
            "inputReformattingEnabled": true,
            "inputMinCharacters": 30,
            "inputPunctuationBoundaries": [
              "。",
              ",",
              ".",
              "!",
              "?",
              ";",
              ")",
              "،",
              "۔",
              "।",
              "॥",
              "|",
              "||",
              ",",
              ":"
            ],
            "fillerInjectionEnabled": true,
            "provider": "azure",
            "voiceId": "andrew",
            "speed": 1.25
          },
          "firstMessageMode": "assistant-speaks-first",
          "recordingEnabled": true,
          "hipaaEnabled": true,
          "clientMessages": [
            "conversation-update",
            "function-call",
            "hang",
            "model-output",
            "speech-update",
            "status-update",
            "transcript",
            "tool-calls",
            "user-interrupted",
            "voice-input"
          ],
          "serverMessages": [
            "conversation-update",
            "end-of-call-report",
            "function-call",
            "hang",
            "speech-update",
            "status-update",
            "tool-calls",
            "transfer-destination-request",
            "user-interrupted"
          ],
          "silenceTimeoutSeconds": 30,
          "responseDelaySeconds": 0.4,
          "llmRequestDelaySeconds": 0.1,
          "llmRequestNonPunctuatedDelaySeconds": 1.5,
          "numWordsToInterruptAssistant": 5,
          "maxDurationSeconds": 1800,
          "backgroundSound": "office",
          "backchannelingEnabled": true,
          "backgroundDenoisingEnabled": true,
          "modelOutputInMessagesEnabled": true,
          "transportConfigurations": [
            {
              "provider": "twilio",
              "timeout": 60,
              "record": true,
              "recordingChannels": "mono"
            }
          ],
          "name": "<string>",
          "firstMessage": "<string>",
          "voicemailDetection": {
            "provider": "twilio",
            "voicemailDetectionTypes": [
              "machine_end_beep",
              "machine_end_silence"
            ],
            "enabled": true,
            "machineDetectionTimeout": 31,
            "machineDetectionSpeechThreshold": 3500,
            "machineDetectionSpeechEndThreshold": 2750,
            "machineDetectionSilenceTimeout": 6000
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "summaryPrompt": "<string>",
            "summaryRequestTimeoutSeconds": 10.5,
            "structuredDataRequestTimeoutSeconds": 10.5,
            "successEvaluationPrompt": "<string>",
            "successEvaluationRubric": "NumericScale",
            "successEvaluationRequestTimeoutSeconds": 10.5,
            "structuredDataPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                "<string>"
              ]
            }
          },
          "artifactPlan": {
            "videoRecordingEnabled": true
          },
          "messagePlan": {
            "idleMessages": [
              "<string>"
            ],
            "idleMessageMaxSpokenCount": 5.5,
            "idleTimeoutSeconds": 17.5
          }
        },
        "assistantOverrides": {
          "transcriber": {
            "provider": "deepgram",
            "model": "nova-2",
            "language": "bg",
            "smartFormat": true,
            "keywords": [
              "<string>"
            ]
          },
          "model": {
            "messages": [
              {
                "content": "<string>",
                "role": "assistant"
              }
            ],
            "tools": [
              {
                "async": true,
                "messages": [
                  {
                    "type": "request-start",
                    "content": "<string>",
                    "conditions": [
                      {
                        "param": "<string>",
                        "value": "<string>",
                        "operator": "eq"
                      }
                    ]
                  }
                ],
                "type": "dtmf",
                "function": {
                  "name": "<string>",
                  "description": "<string>",
                  "parameters": {
                    "type": "object",
                    "properties": {},
                    "required": [
                      "<string>"
                    ]
                  }
                },
                "server": {
                  "timeoutSeconds": 20,
                  "url": "<string>",
                  "secret": "<string>"
                }
              }
            ],
            "toolIds": [
              "<string>"
            ],
            "provider": "anyscale",
            "model": "<string>",
            "temperature": 1,
            "knowledgeBase": {
              "provider": "canonical",
              "topK": 5.5,
              "fileIds": [
                "<string>"
              ]
            },
            "maxTokens": 525,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "inputPreprocessingEnabled": true,
            "inputReformattingEnabled": true,
            "inputMinCharacters": 30,
            "inputPunctuationBoundaries": [
              "。",
              ",",
              ".",
              "!",
              "?",
              ";",
              ")",
              "،",
              "۔",
              "।",
              "॥",
              "|",
              "||",
              ",",
              ":"
            ],
            "fillerInjectionEnabled": true,
            "provider": "azure",
            "voiceId": "andrew",
            "speed": 1.25
          },
          "firstMessageMode": "assistant-speaks-first",
          "recordingEnabled": true,
          "hipaaEnabled": true,
          "clientMessages": [
            "conversation-update",
            "function-call",
            "hang",
            "model-output",
            "speech-update",
            "status-update",
            "transcript",
            "tool-calls",
            "user-interrupted",
            "voice-input"
          ],
          "serverMessages": [
            "conversation-update",
            "end-of-call-report",
            "function-call",
            "hang",
            "speech-update",
            "status-update",
            "tool-calls",
            "transfer-destination-request",
            "user-interrupted"
          ],
          "silenceTimeoutSeconds": 30,
          "responseDelaySeconds": 0.4,
          "llmRequestDelaySeconds": 0.1,
          "llmRequestNonPunctuatedDelaySeconds": 1.5,
          "numWordsToInterruptAssistant": 5,
          "maxDurationSeconds": 1800,
          "backgroundSound": "office",
          "backchannelingEnabled": true,
          "backgroundDenoisingEnabled": true,
          "modelOutputInMessagesEnabled": true,
          "transportConfigurations": [
            {
              "provider": "twilio",
              "timeout": 60,
              "record": true,
              "recordingChannels": "mono"
            }
          ],
          "variableValues": {},
          "name": "<string>",
          "firstMessage": "<string>",
          "voicemailDetection": {
            "provider": "twilio",
            "voicemailDetectionTypes": [
              "machine_end_beep",
              "machine_end_silence"
            ],
            "enabled": true,
            "machineDetectionTimeout": 31,
            "machineDetectionSpeechThreshold": 3500,
            "machineDetectionSpeechEndThreshold": 2750,
            "machineDetectionSilenceTimeout": 6000
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "summaryPrompt": "<string>",
            "summaryRequestTimeoutSeconds": 10.5,
            "structuredDataRequestTimeoutSeconds": 10.5,
            "successEvaluationPrompt": "<string>",
            "successEvaluationRubric": "NumericScale",
            "successEvaluationRequestTimeoutSeconds": 10.5,
            "structuredDataPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                "<string>"
              ]
            }
          },
          "artifactPlan": {
            "videoRecordingEnabled": true
          },
          "messagePlan": {
            "idleMessages": [
              "<string>"
            ],
            "idleMessageMaxSpokenCount": 5.5,
            "idleTimeoutSeconds": 17.5
          }
        },
        "assistantDestinations": [
          {
            "type": "assistant",
            "assistantName": "<string>",
            "message": "<string>",
            "description": "<string>"
          }
        ]
      }
    ],
    "membersOverrides": {
      "transcriber": {
        "provider": "deepgram",
        "model": "nova-2",
        "language": "bg",
        "smartFormat": true,
        "keywords": [
          "<string>"
        ]
      },
      "model": {
        "messages": [
          {
            "content": "<string>",
            "role": "assistant"
          }
        ],
        "tools": [
          {
            "async": true,
            "messages": [
              {
                "type": "request-start",
                "content": "<string>",
                "conditions": [
                  {
                    "param": "<string>",
                    "value": "<string>",
                    "operator": "eq"
                  }
                ]
              }
            ],
            "type": "dtmf",
            "function": {
              "name": "<string>",
              "description": "<string>",
              "parameters": {
                "type": "object",
                "properties": {},
                "required": [
                  "<string>"
                ]
              }
            },
            "server": {
              "timeoutSeconds": 20,
              "url": "<string>",
              "secret": "<string>"
            }
          }
        ],
        "toolIds": [
          "<string>"
        ],
        "provider": "anyscale",
        "model": "<string>",
        "temperature": 1,
        "knowledgeBase": {
          "provider": "canonical",
          "topK": 5.5,
          "fileIds": [
            "<string>"
          ]
        },
        "maxTokens": 525,
        "emotionRecognitionEnabled": true
      },
      "voice": {
        "inputPreprocessingEnabled": true,
        "inputReformattingEnabled": true,
        "inputMinCharacters": 30,
        "inputPunctuationBoundaries": [
          "。",
          ",",
          ".",
          "!",
          "?",
          ";",
          ")",
          "،",
          "۔",
          "।",
          "॥",
          "|",
          "||",
          ",",
          ":"
        ],
        "fillerInjectionEnabled": true,
        "provider": "azure",
        "voiceId": "andrew",
        "speed": 1.25
      },
      "firstMessageMode": "assistant-speaks-first",
      "recordingEnabled": true,
      "hipaaEnabled": true,
      "clientMessages": [
        "conversation-update",
        "function-call",
        "hang",
        "model-output",
        "speech-update",
        "status-update",
        "transcript",
        "tool-calls",
        "user-interrupted",
        "voice-input"
      ],
      "serverMessages": [
        "conversation-update",
        "end-of-call-report",
        "function-call",
        "hang",
        "speech-update",
        "status-update",
        "tool-calls",
        "transfer-destination-request",
        "user-interrupted"
      ],
      "silenceTimeoutSeconds": 30,
      "responseDelaySeconds": 0.4,
      "llmRequestDelaySeconds": 0.1,
      "llmRequestNonPunctuatedDelaySeconds": 1.5,
      "numWordsToInterruptAssistant": 5,
      "maxDurationSeconds": 1800,
      "backgroundSound": "office",
      "backchannelingEnabled": true,
      "backgroundDenoisingEnabled": true,
      "modelOutputInMessagesEnabled": true,
      "transportConfigurations": [
        {
          "provider": "twilio",
          "timeout": 60,
          "record": true,
          "recordingChannels": "mono"
        }
      ],
      "variableValues": {},
      "name": "<string>",
      "firstMessage": "<string>",
      "voicemailDetection": {
        "provider": "twilio",
        "voicemailDetectionTypes": [
          "machine_end_beep",
          "machine_end_silence"
        ],
        "enabled": true,
        "machineDetectionTimeout": 31,
        "machineDetectionSpeechThreshold": 3500,
        "machineDetectionSpeechEndThreshold": 2750,
        "machineDetectionSilenceTimeout": 6000
      },
      "voicemailMessage": "<string>",
      "endCallMessage": "<string>",
      "endCallPhrases": [
        "<string>"
      ],
      "metadata": {},
      "serverUrl": "<string>",
      "serverUrlSecret": "<string>",
      "analysisPlan": {
        "summaryPrompt": "<string>",
        "summaryRequestTimeoutSeconds": 10.5,
        "structuredDataRequestTimeoutSeconds": 10.5,
        "successEvaluationPrompt": "<string>",
        "successEvaluationRubric": "NumericScale",
        "successEvaluationRequestTimeoutSeconds": 10.5,
        "structuredDataPrompt": "<string>",
        "structuredDataSchema": {
          "type": "string",
          "items": {},
          "properties": {},
          "description": "<string>",
          "required": [
            "<string>"
          ]
        }
      },
      "artifactPlan": {
        "videoRecordingEnabled": true
      },
      "messagePlan": {
        "idleMessages": [
          "<string>"
        ],
        "idleMessageMaxSpokenCount": 5.5,
        "idleTimeoutSeconds": 17.5
      }
    }
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "fallbackDestination": {
      "type": "number",
      "number": "<string>",
      "message": "<string>",
      "description": "<string>"
    },
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "squadId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "sipUri": "<string>",
    "name": "<string>",
    "extension": "<string>"
  }
}'
{
  "type": "inboundPhoneCall",
  "messages": [
    {
      "role": "<string>",
      "message": "<string>",
      "time": 123,
      "endTime": 123,
      "secondsFromStart": 123,
      "duration": 123
    }
  ],
  "phoneCallProvider": "twilio",
  "phoneCallTransport": "sip",
  "status": "queued",
  "endedReason": "assistant-error",
  "id": "<string>",
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "cost": 123,
  "costBreakdown": {
    "transport": 123,
    "stt": 123,
    "llm": 123,
    "tts": 123,
    "vapi": 123,
    "total": 123,
    "llmPromptTokens": 123,
    "llmCompletionTokens": 123,
    "ttsCharacters": 123,
    "analysisCostBreakdown": {
      "summary": 123,
      "summaryPromptTokens": 123,
      "summaryCompletionTokens": 123,
      "structuredData": 123,
      "structuredDataPromptTokens": 123,
      "structuredDataCompletionTokens": 123,
      "successEvaluation": 123,
      "successEvaluationPromptTokens": 123,
      "successEvaluationCompletionTokens": 123
    }
  },
  "transcript": "<string>",
  "recordingUrl": "<string>",
  "stereoRecordingUrl": "<string>",
  "artifact": {
    "videoRecordingUrl": "<string>",
    "videoRecordingStartDelaySeconds": 123
  },
  "artifactPlan": {
    "videoRecordingEnabled": true
  },
  "analysis": {
    "summary": "<string>",
    "structuredData": {},
    "successEvaluation": "<string>"
  },
  "phoneCallProviderId": "<string>",
  "forwardedPhoneNumber": "<string>",
  "assistantId": "<string>",
  "assistant": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "bg",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant"
        }
      ],
      "tools": [
        {
          "async": true,
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": "<string>",
                  "operator": "eq"
                }
              ]
            }
          ],
          "type": "dtmf",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          },
          "server": {
            "timeoutSeconds": 20,
            "url": "<string>",
            "secret": "<string>"
          }
        }
      ],
      "toolIds": [
        "<string>"
      ],
      "provider": "anyscale",
      "model": "<string>",
      "temperature": 1,
      "knowledgeBase": {
        "provider": "canonical",
        "topK": 5.5,
        "fileIds": [
          "<string>"
        ]
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputPreprocessingEnabled": true,
      "inputReformattingEnabled": true,
      "inputMinCharacters": 30,
      "inputPunctuationBoundaries": [
        "。",
        ",",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "firstMessageMode": "assistant-speaks-first",
    "recordingEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "conversation-update",
      "function-call",
      "hang",
      "model-output",
      "speech-update",
      "status-update",
      "transcript",
      "tool-calls",
      "user-interrupted",
      "voice-input"
    ],
    "serverMessages": [
      "conversation-update",
      "end-of-call-report",
      "function-call",
      "hang",
      "speech-update",
      "status-update",
      "tool-calls",
      "transfer-destination-request",
      "user-interrupted"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "llmRequestNonPunctuatedDelaySeconds": 1.5,
    "numWordsToInterruptAssistant": 5,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "backgroundDenoisingEnabled": true,
    "modelOutputInMessagesEnabled": true,
    "transportConfigurations": [
      {
        "provider": "twilio",
        "timeout": 60,
        "record": true,
        "recordingChannels": "mono"
      }
    ],
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetection": {
      "provider": "twilio",
      "voicemailDetectionTypes": [
        "machine_end_beep",
        "machine_end_silence"
      ],
      "enabled": true,
      "machineDetectionTimeout": 31,
      "machineDetectionSpeechThreshold": 3500,
      "machineDetectionSpeechEndThreshold": 2750,
      "machineDetectionSilenceTimeout": 6000
    },
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "analysisPlan": {
      "summaryPrompt": "<string>",
      "summaryRequestTimeoutSeconds": 10.5,
      "structuredDataRequestTimeoutSeconds": 10.5,
      "successEvaluationPrompt": "<string>",
      "successEvaluationRubric": "NumericScale",
      "successEvaluationRequestTimeoutSeconds": 10.5,
      "structuredDataPrompt": "<string>",
      "structuredDataSchema": {
        "type": "string",
        "items": {},
        "properties": {},
        "description": "<string>",
        "required": [
          "<string>"
        ]
      }
    },
    "artifactPlan": {
      "videoRecordingEnabled": true
    },
    "messagePlan": {
      "idleMessages": [
        "<string>"
      ],
      "idleMessageMaxSpokenCount": 5.5,
      "idleTimeoutSeconds": 17.5
    }
  },
  "assistantOverrides": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "bg",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant"
        }
      ],
      "tools": [
        {
          "async": true,
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": "<string>",
                  "operator": "eq"
                }
              ]
            }
          ],
          "type": "dtmf",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          },
          "server": {
            "timeoutSeconds": 20,
            "url": "<string>",
            "secret": "<string>"
          }
        }
      ],
      "toolIds": [
        "<string>"
      ],
      "provider": "anyscale",
      "model": "<string>",
      "temperature": 1,
      "knowledgeBase": {
        "provider": "canonical",
        "topK": 5.5,
        "fileIds": [
          "<string>"
        ]
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputPreprocessingEnabled": true,
      "inputReformattingEnabled": true,
      "inputMinCharacters": 30,
      "inputPunctuationBoundaries": [
        "。",
        ",",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "firstMessageMode": "assistant-speaks-first",
    "recordingEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "conversation-update",
      "function-call",
      "hang",
      "model-output",
      "speech-update",
      "status-update",
      "transcript",
      "tool-calls",
      "user-interrupted",
      "voice-input"
    ],
    "serverMessages": [
      "conversation-update",
      "end-of-call-report",
      "function-call",
      "hang",
      "speech-update",
      "status-update",
      "tool-calls",
      "transfer-destination-request",
      "user-interrupted"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "llmRequestNonPunctuatedDelaySeconds": 1.5,
    "numWordsToInterruptAssistant": 5,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "backgroundDenoisingEnabled": true,
    "modelOutputInMessagesEnabled": true,
    "transportConfigurations": [
      {
        "provider": "twilio",
        "timeout": 60,
        "record": true,
        "recordingChannels": "mono"
      }
    ],
    "variableValues": {},
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetection": {
      "provider": "twilio",
      "voicemailDetectionTypes": [
        "machine_end_beep",
        "machine_end_silence"
      ],
      "enabled": true,
      "machineDetectionTimeout": 31,
      "machineDetectionSpeechThreshold": 3500,
      "machineDetectionSpeechEndThreshold": 2750,
      "machineDetectionSilenceTimeout": 6000
    },
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "analysisPlan": {
      "summaryPrompt": "<string>",
      "summaryRequestTimeoutSeconds": 10.5,
      "structuredDataRequestTimeoutSeconds": 10.5,
      "successEvaluationPrompt": "<string>",
      "successEvaluationRubric": "NumericScale",
      "successEvaluationRequestTimeoutSeconds": 10.5,
      "structuredDataPrompt": "<string>",
      "structuredDataSchema": {
        "type": "string",
        "items": {},
        "properties": {},
        "description": "<string>",
        "required": [
          "<string>"
        ]
      }
    },
    "artifactPlan": {
      "videoRecordingEnabled": true
    },
    "messagePlan": {
      "idleMessages": [
        "<string>"
      ],
      "idleMessageMaxSpokenCount": 5.5,
      "idleTimeoutSeconds": 17.5
    }
  },
  "squadId": "<string>",
  "squad": {
    "name": "<string>",
    "members": [
      {
        "assistantId": "<string>",
        "assistant": {
          "transcriber": {
            "provider": "deepgram",
            "model": "nova-2",
            "language": "bg",
            "smartFormat": true,
            "keywords": [
              "<string>"
            ]
          },
          "model": {
            "messages": [
              {
                "content": "<string>",
                "role": "assistant"
              }
            ],
            "tools": [
              {
                "async": true,
                "messages": [
                  {
                    "type": "request-start",
                    "content": "<string>",
                    "conditions": [
                      {
                        "param": "<string>",
                        "value": "<string>",
                        "operator": "eq"
                      }
                    ]
                  }
                ],
                "type": "dtmf",
                "function": {
                  "name": "<string>",
                  "description": "<string>",
                  "parameters": {
                    "type": "object",
                    "properties": {},
                    "required": [
                      "<string>"
                    ]
                  }
                },
                "server": {
                  "timeoutSeconds": 20,
                  "url": "<string>",
                  "secret": "<string>"
                }
              }
            ],
            "toolIds": [
              "<string>"
            ],
            "provider": "anyscale",
            "model": "<string>",
            "temperature": 1,
            "knowledgeBase": {
              "provider": "canonical",
              "topK": 5.5,
              "fileIds": [
                "<string>"
              ]
            },
            "maxTokens": 525,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "inputPreprocessingEnabled": true,
            "inputReformattingEnabled": true,
            "inputMinCharacters": 30,
            "inputPunctuationBoundaries": [
              "。",
              ",",
              ".",
              "!",
              "?",
              ";",
              ")",
              "،",
              "۔",
              "।",
              "॥",
              "|",
              "||",
              ",",
              ":"
            ],
            "fillerInjectionEnabled": true,
            "provider": "azure",
            "voiceId": "andrew",
            "speed": 1.25
          },
          "firstMessageMode": "assistant-speaks-first",
          "recordingEnabled": true,
          "hipaaEnabled": true,
          "clientMessages": [
            "conversation-update",
            "function-call",
            "hang",
            "model-output",
            "speech-update",
            "status-update",
            "transcript",
            "tool-calls",
            "user-interrupted",
            "voice-input"
          ],
          "serverMessages": [
            "conversation-update",
            "end-of-call-report",
            "function-call",
            "hang",
            "speech-update",
            "status-update",
            "tool-calls",
            "transfer-destination-request",
            "user-interrupted"
          ],
          "silenceTimeoutSeconds": 30,
          "responseDelaySeconds": 0.4,
          "llmRequestDelaySeconds": 0.1,
          "llmRequestNonPunctuatedDelaySeconds": 1.5,
          "numWordsToInterruptAssistant": 5,
          "maxDurationSeconds": 1800,
          "backgroundSound": "office",
          "backchannelingEnabled": true,
          "backgroundDenoisingEnabled": true,
          "modelOutputInMessagesEnabled": true,
          "transportConfigurations": [
            {
              "provider": "twilio",
              "timeout": 60,
              "record": true,
              "recordingChannels": "mono"
            }
          ],
          "name": "<string>",
          "firstMessage": "<string>",
          "voicemailDetection": {
            "provider": "twilio",
            "voicemailDetectionTypes": [
              "machine_end_beep",
              "machine_end_silence"
            ],
            "enabled": true,
            "machineDetectionTimeout": 31,
            "machineDetectionSpeechThreshold": 3500,
            "machineDetectionSpeechEndThreshold": 2750,
            "machineDetectionSilenceTimeout": 6000
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "summaryPrompt": "<string>",
            "summaryRequestTimeoutSeconds": 10.5,
            "structuredDataRequestTimeoutSeconds": 10.5,
            "successEvaluationPrompt": "<string>",
            "successEvaluationRubric": "NumericScale",
            "successEvaluationRequestTimeoutSeconds": 10.5,
            "structuredDataPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                "<string>"
              ]
            }
          },
          "artifactPlan": {
            "videoRecordingEnabled": true
          },
          "messagePlan": {
            "idleMessages": [
              "<string>"
            ],
            "idleMessageMaxSpokenCount": 5.5,
            "idleTimeoutSeconds": 17.5
          }
        },
        "assistantOverrides": {
          "transcriber": {
            "provider": "deepgram",
            "model": "nova-2",
            "language": "bg",
            "smartFormat": true,
            "keywords": [
              "<string>"
            ]
          },
          "model": {
            "messages": [
              {
                "content": "<string>",
                "role": "assistant"
              }
            ],
            "tools": [
              {
                "async": true,
                "messages": [
                  {
                    "type": "request-start",
                    "content": "<string>",
                    "conditions": [
                      {
                        "param": "<string>",
                        "value": "<string>",
                        "operator": "eq"
                      }
                    ]
                  }
                ],
                "type": "dtmf",
                "function": {
                  "name": "<string>",
                  "description": "<string>",
                  "parameters": {
                    "type": "object",
                    "properties": {},
                    "required": [
                      "<string>"
                    ]
                  }
                },
                "server": {
                  "timeoutSeconds": 20,
                  "url": "<string>",
                  "secret": "<string>"
                }
              }
            ],
            "toolIds": [
              "<string>"
            ],
            "provider": "anyscale",
            "model": "<string>",
            "temperature": 1,
            "knowledgeBase": {
              "provider": "canonical",
              "topK": 5.5,
              "fileIds": [
                "<string>"
              ]
            },
            "maxTokens": 525,
            "emotionRecognitionEnabled": true
          },
          "voice": {
            "inputPreprocessingEnabled": true,
            "inputReformattingEnabled": true,
            "inputMinCharacters": 30,
            "inputPunctuationBoundaries": [
              "。",
              ",",
              ".",
              "!",
              "?",
              ";",
              ")",
              "،",
              "۔",
              "।",
              "॥",
              "|",
              "||",
              ",",
              ":"
            ],
            "fillerInjectionEnabled": true,
            "provider": "azure",
            "voiceId": "andrew",
            "speed": 1.25
          },
          "firstMessageMode": "assistant-speaks-first",
          "recordingEnabled": true,
          "hipaaEnabled": true,
          "clientMessages": [
            "conversation-update",
            "function-call",
            "hang",
            "model-output",
            "speech-update",
            "status-update",
            "transcript",
            "tool-calls",
            "user-interrupted",
            "voice-input"
          ],
          "serverMessages": [
            "conversation-update",
            "end-of-call-report",
            "function-call",
            "hang",
            "speech-update",
            "status-update",
            "tool-calls",
            "transfer-destination-request",
            "user-interrupted"
          ],
          "silenceTimeoutSeconds": 30,
          "responseDelaySeconds": 0.4,
          "llmRequestDelaySeconds": 0.1,
          "llmRequestNonPunctuatedDelaySeconds": 1.5,
          "numWordsToInterruptAssistant": 5,
          "maxDurationSeconds": 1800,
          "backgroundSound": "office",
          "backchannelingEnabled": true,
          "backgroundDenoisingEnabled": true,
          "modelOutputInMessagesEnabled": true,
          "transportConfigurations": [
            {
              "provider": "twilio",
              "timeout": 60,
              "record": true,
              "recordingChannels": "mono"
            }
          ],
          "variableValues": {},
          "name": "<string>",
          "firstMessage": "<string>",
          "voicemailDetection": {
            "provider": "twilio",
            "voicemailDetectionTypes": [
              "machine_end_beep",
              "machine_end_silence"
            ],
            "enabled": true,
            "machineDetectionTimeout": 31,
            "machineDetectionSpeechThreshold": 3500,
            "machineDetectionSpeechEndThreshold": 2750,
            "machineDetectionSilenceTimeout": 6000
          },
          "voicemailMessage": "<string>",
          "endCallMessage": "<string>",
          "endCallPhrases": [
            "<string>"
          ],
          "metadata": {},
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "analysisPlan": {
            "summaryPrompt": "<string>",
            "summaryRequestTimeoutSeconds": 10.5,
            "structuredDataRequestTimeoutSeconds": 10.5,
            "successEvaluationPrompt": "<string>",
            "successEvaluationRubric": "NumericScale",
            "successEvaluationRequestTimeoutSeconds": 10.5,
            "structuredDataPrompt": "<string>",
            "structuredDataSchema": {
              "type": "string",
              "items": {},
              "properties": {},
              "description": "<string>",
              "required": [
                "<string>"
              ]
            }
          },
          "artifactPlan": {
            "videoRecordingEnabled": true
          },
          "messagePlan": {
            "idleMessages": [
              "<string>"
            ],
            "idleMessageMaxSpokenCount": 5.5,
            "idleTimeoutSeconds": 17.5
          }
        },
        "assistantDestinations": [
          {
            "type": "assistant",
            "assistantName": "<string>",
            "message": "<string>",
            "description": "<string>"
          }
        ]
      }
    ],
    "membersOverrides": {
      "transcriber": {
        "provider": "deepgram",
        "model": "nova-2",
        "language": "bg",
        "smartFormat": true,
        "keywords": [
          "<string>"
        ]
      },
      "model": {
        "messages": [
          {
            "content": "<string>",
            "role": "assistant"
          }
        ],
        "tools": [
          {
            "async": true,
            "messages": [
              {
                "type": "request-start",
                "content": "<string>",
                "conditions": [
                  {
                    "param": "<string>",
                    "value": "<string>",
                    "operator": "eq"
                  }
                ]
              }
            ],
            "type": "dtmf",
            "function": {
              "name": "<string>",
              "description": "<string>",
              "parameters": {
                "type": "object",
                "properties": {},
                "required": [
                  "<string>"
                ]
              }
            },
            "server": {
              "timeoutSeconds": 20,
              "url": "<string>",
              "secret": "<string>"
            }
          }
        ],
        "toolIds": [
          "<string>"
        ],
        "provider": "anyscale",
        "model": "<string>",
        "temperature": 1,
        "knowledgeBase": {
          "provider": "canonical",
          "topK": 5.5,
          "fileIds": [
            "<string>"
          ]
        },
        "maxTokens": 525,
        "emotionRecognitionEnabled": true
      },
      "voice": {
        "inputPreprocessingEnabled": true,
        "inputReformattingEnabled": true,
        "inputMinCharacters": 30,
        "inputPunctuationBoundaries": [
          "。",
          ",",
          ".",
          "!",
          "?",
          ";",
          ")",
          "،",
          "۔",
          "।",
          "॥",
          "|",
          "||",
          ",",
          ":"
        ],
        "fillerInjectionEnabled": true,
        "provider": "azure",
        "voiceId": "andrew",
        "speed": 1.25
      },
      "firstMessageMode": "assistant-speaks-first",
      "recordingEnabled": true,
      "hipaaEnabled": true,
      "clientMessages": [
        "conversation-update",
        "function-call",
        "hang",
        "model-output",
        "speech-update",
        "status-update",
        "transcript",
        "tool-calls",
        "user-interrupted",
        "voice-input"
      ],
      "serverMessages": [
        "conversation-update",
        "end-of-call-report",
        "function-call",
        "hang",
        "speech-update",
        "status-update",
        "tool-calls",
        "transfer-destination-request",
        "user-interrupted"
      ],
      "silenceTimeoutSeconds": 30,
      "responseDelaySeconds": 0.4,
      "llmRequestDelaySeconds": 0.1,
      "llmRequestNonPunctuatedDelaySeconds": 1.5,
      "numWordsToInterruptAssistant": 5,
      "maxDurationSeconds": 1800,
      "backgroundSound": "office",
      "backchannelingEnabled": true,
      "backgroundDenoisingEnabled": true,
      "modelOutputInMessagesEnabled": true,
      "transportConfigurations": [
        {
          "provider": "twilio",
          "timeout": 60,
          "record": true,
          "recordingChannels": "mono"
        }
      ],
      "variableValues": {},
      "name": "<string>",
      "firstMessage": "<string>",
      "voicemailDetection": {
        "provider": "twilio",
        "voicemailDetectionTypes": [
          "machine_end_beep",
          "machine_end_silence"
        ],
        "enabled": true,
        "machineDetectionTimeout": 31,
        "machineDetectionSpeechThreshold": 3500,
        "machineDetectionSpeechEndThreshold": 2750,
        "machineDetectionSilenceTimeout": 6000
      },
      "voicemailMessage": "<string>",
      "endCallMessage": "<string>",
      "endCallPhrases": [
        "<string>"
      ],
      "metadata": {},
      "serverUrl": "<string>",
      "serverUrlSecret": "<string>",
      "analysisPlan": {
        "summaryPrompt": "<string>",
        "summaryRequestTimeoutSeconds": 10.5,
        "structuredDataRequestTimeoutSeconds": 10.5,
        "successEvaluationPrompt": "<string>",
        "successEvaluationRubric": "NumericScale",
        "successEvaluationRequestTimeoutSeconds": 10.5,
        "structuredDataPrompt": "<string>",
        "structuredDataSchema": {
          "type": "string",
          "items": {},
          "properties": {},
          "description": "<string>",
          "required": [
            "<string>"
          ]
        }
      },
      "artifactPlan": {
        "videoRecordingEnabled": true
      },
      "messagePlan": {
        "idleMessages": [
          "<string>"
        ],
        "idleMessageMaxSpokenCount": 5.5,
        "idleTimeoutSeconds": 17.5
      }
    }
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "fallbackDestination": {
      "type": "number",
      "number": "<string>",
      "message": "<string>",
      "description": "<string>"
    },
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "squadId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "sipUri": "<string>",
    "name": "<string>",
    "extension": "<string>"
  },
  "name": "<string>"
}

Authorizations

Authorization
string
headerrequired

Retrieve your API Key from Dashboard.

Body

application/json
name
string

This is the name of the call. This is just for your own reference.

assistantId
string

This is the assistant that will be used for the call. To use a transient assistant, use assistant instead.

assistant
object

This is the assistant that will be used for the call. To use an existing assistant, use assistantId instead.