GET
/
call
/
{id}
curl --request GET \
  --url https://api.vapi.ai/call/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

id
string
required

Response

200 - application/json
type
enum<string>

This is the type of call.

Available options:
inboundPhoneCall,
outboundPhoneCall,
webCall
messages
object[]

These are the messages that were spoken during the call.

phoneCallProvider
enum<string>

This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Available options:
twilio,
vonage,
vapi
phoneCallTransport
enum<string>

This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Available options:
sip,
pstn
status
enum<string>

This is the status of the call.

Available options:
queued,
ringing,
in-progress,
forwarding,
ended
endedReason
enum<string>

This is the explanation for how the call ended.

Available options:
assistant-error,
assistant-not-found,
db-error,
no-server-available,
pipeline-error-extra-function-failed,
pipeline-error-first-message-failed,
pipeline-error-function-filler-failed,
pipeline-error-function-failed,
pipeline-error-openai-llm-failed,
pipeline-error-azure-openai-llm-failed,
pipeline-error-together-ai-llm-failed,
pipeline-error-anyscale-llm-failed,
pipeline-error-openrouter-llm-failed,
pipeline-error-perplexity-ai-llm-failed,
pipeline-error-deepinfra-llm-failed,
pipeline-error-runpod-llm-failed,
pipeline-error-groq-llm-failed,
pipeline-error-anthropic-llm-failed,
pipeline-error-openai-voice-failed,
pipeline-error-cartesia-voice-failed,
pipeline-error-deepgram-transcriber-failed,
pipeline-error-deepgram-voice-failed,
pipeline-error-gladia-transcriber-failed,
pipeline-error-eleven-labs-voice-failed,
pipeline-error-playht-voice-failed,
pipeline-error-lmnt-voice-failed,
pipeline-error-azure-voice-failed,
pipeline-error-rime-ai-voice-failed,
pipeline-error-neets-voice-failed,
pipeline-no-available-model,
server-shutdown,
twilio-failed-to-connect-call,
unknown-error,
vonage-disconnected,
vonage-failed-to-connect-call,
phone-call-provider-bypass-enabled-but-no-call-received,
vapi-error-phone-call-worker-setup-socket-error,
vapi-error-phone-call-worker-worker-setup-socket-timeout,
vapi-error-phone-call-worker-could-not-find-call,
vapi-error-phone-call-worker-call-never-connected,
vapi-error-web-call-worker-setup-failed,
assistant-not-invalid,
assistant-not-provided,
call-start-error-neither-assistant-nor-server-set,
assistant-request-failed,
assistant-request-returned-error,
assistant-request-returned-unspeakable-error,
assistant-request-returned-invalid-assistant,
assistant-request-returned-no-assistant,
assistant-request-returned-forwarding-phone-number,
assistant-ended-call,
assistant-said-end-call-phrase,
assistant-forwarded-call,
assistant-join-timed-out,
customer-busy,
customer-ended-call,
customer-did-not-answer,
customer-did-not-give-microphone-permission,
incoming-client-message-say-ended-call,
exceeded-max-duration,
manually-canceled,
phone-call-provider-closed-websocket,
pipeline-error-custom-llm-llm-failed,
pipeline-error-eleven-labs-voice-not-found,
pipeline-error-eleven-labs-quota-exceeded,
pipeline-error-eleven-labs-unauthorized-access,
pipeline-error-eleven-labs-unauthorized-to-access-model,
pipeline-error-eleven-labs-professional-voices-only-for-creator-plus,
pipeline-error-eleven-labs-blocked-free-plan-and-requested-upgrade,
pipeline-error-eleven-labs-blocked-concurrent-requests-and-requested-upgrade,
pipeline-error-eleven-labs-blocked-using-instant-voice-clone-and-requested-upgrade,
pipeline-error-eleven-labs-system-busy-and-requested-upgrade,
pipeline-error-eleven-labs-voice-not-fine-tuned,
pipeline-error-eleven-labs-invalid-api-key,
pipeline-error-eleven-labs-invalid-voice-samples,
pipeline-error-playht-request-timed-out,
pipeline-error-playht-invalid-voice,
pipeline-error-playht-unexpected-error,
pipeline-error-playht-out-of-credits,
pipeline-error-playht-rate-limit-exceeded,
pipeline-error-playht-502-gateway-error,
pipeline-error-playht-504-gateway-error,
pipeline-error-gladia-transcriber-failed,
silence-timed-out,
voicemail,
vonage-rejected
id
string
required

This is the unique identifier for the call.

orgId
string
required

This is the unique identifier for the org that this call belongs to.

createdAt
string
required

This is the ISO 8601 date-time string of when the call was created.

updatedAt
string
required

This is the ISO 8601 date-time string of when the call was last updated.

startedAt
string

This is the ISO 8601 date-time string of when the call was started.

endedAt
string

This is the ISO 8601 date-time string of when the call was ended.

cost
number

This is the cost of the call in USD.

costBreakdown
object

This is the cost of the call in USD.

transcript
string

This is the transcript of the call.

recordingUrl
string

This is the URL of the recording of the call.

stereoRecordingUrl
string

This is the URL of the recording of the call in two channels.

artifact
object

This stores artifacts of the call. Customize what artifacts are created by configuring assistant.artifactPlan.

artifactPlan
object

This is a copy of assistant artifact plan. This isn't actually stored on the call but rather just returned in POST /call/web to enable artifact creation client side.

analysis
object

This is the analysis of the call. Customize the analysis by configuring assistant.analysisPlan.

phoneCallProviderId
string

The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

forwardedPhoneNumber
string

This is the phone number that the call was forwarded to.

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.

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.

squad
object

This is a squad that will be used for the call. To use an existing squad, use squadId instead.

phoneNumberId
string

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

Only relevant for outboundPhoneCall and inboundPhoneCall type.

phoneNumber
object

This is the phone number that will be used for the call. To use an existing number, use phoneNumberId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerId
string

This is the customer that will be called. To call a transient customer , use customer instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customer
object

This is the customer that will be called. To call an existing customer, use customerId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

name
string

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