Create Call
curl --request POST \
--url https://api.voicebot.studio/api/v1/calls \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"assistantId": "<string>",
"assistant": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": false,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": [
"<string>"
],
"provider": "canonical"
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": true,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": false,
"enableSsmlParsing": false,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": false,
"clientMessages": [
"<string>"
],
"serverMessages": [
"end-of-call-report"
],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": true,
"modelOutputInMessagesEnabled": true,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": true
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": true,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": [
"machine_end_beep",
"machine_end_silence"
],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": true,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": true,
"videoRecordingEnabled": true,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": true,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": true,
"controlEnabled": true
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>"
},
"assistantOverrides": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": false,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": [
"<string>"
],
"provider": "canonical"
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": true,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": false,
"enableSsmlParsing": false,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": false,
"clientMessages": [
"<string>"
],
"serverMessages": [
"end-of-call-report"
],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": true,
"modelOutputInMessagesEnabled": true,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": true
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": true,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": [
"machine_end_beep",
"machine_end_silence"
],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": true,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": true,
"videoRecordingEnabled": true,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": true,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": true,
"controlEnabled": true
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>",
"variableValues": {}
},
"squadId": "<string>",
"squad": {
"name": "<string>",
"assistants": [
{
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": false,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": [
"<string>"
],
"provider": "canonical"
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": true,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": false,
"enableSsmlParsing": false,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": false,
"clientMessages": [
"<string>"
],
"serverMessages": [
"end-of-call-report"
],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": true,
"modelOutputInMessagesEnabled": true,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": true
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": true,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": [
"machine_end_beep",
"machine_end_silence"
],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": true,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": true,
"videoRecordingEnabled": true,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": true,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": true,
"controlEnabled": true
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>"
}
]
},
"phoneNumberId": "<string>",
"phoneNumber": {
"number": "<string>",
"twilioAccountSid": "<string>",
"twilioAuthToken": "<string>",
"provider": "twilio",
"name": "<string>",
"assistantId": "<string>",
"squadId": "<string>",
"fallbackDestination": {
"number": "<string>",
"type": "number",
"extension": "<string>",
"callerId": "<string>",
"message": "<string>",
"description": "<string>",
"numberE164CheckEnabled": true
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"customerId": "<string>",
"customer": {
"extension": "<string>",
"number": "<string>",
"sipUri": "<string>",
"name": "<string>",
"numberE164CheckEnabled": true
}
}
'import requests
url = "https://api.voicebot.studio/api/v1/calls"
payload = {
"name": "<string>",
"assistantId": "<string>",
"assistant": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": False,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": False,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": ["<string>"]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": ["<string>"],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": ["<string>"],
"provider": "canonical"
},
"fallbackModels": ["standard"],
"semanticCachingEnabled": True,
"emotionRecognitionEnabled": True
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": True,
"minCharacters": 30,
"punctuationBoundaries": ["<string>"],
"formatPlan": {
"enabled": True,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": True,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": False,
"enableSsmlParsing": False,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": False,
"clientMessages": ["<string>"],
"serverMessages": ["end-of-call-report"],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": True,
"modelOutputInMessagesEnabled": True,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": True
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": True,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": ["<string>"],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": ["<string>"]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": True,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": True,
"videoRecordingEnabled": True,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": ["<string>"],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": True,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": True,
"controlEnabled": True
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": True,
"languageDetectionEnabled": True,
"keywords": ["<string>"],
"endpointing": 123
},
"dialKeypadFunctionEnabled": True,
"endCallFunctionEnabled": True,
"forwardingPhoneNumber": "<string>"
},
"assistantOverrides": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": False,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": False,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": ["<string>"]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": ["<string>"],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": ["<string>"],
"provider": "canonical"
},
"fallbackModels": ["standard"],
"semanticCachingEnabled": True,
"emotionRecognitionEnabled": True
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": True,
"minCharacters": 30,
"punctuationBoundaries": ["<string>"],
"formatPlan": {
"enabled": True,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": True,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": False,
"enableSsmlParsing": False,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": False,
"clientMessages": ["<string>"],
"serverMessages": ["end-of-call-report"],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": True,
"modelOutputInMessagesEnabled": True,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": True
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": True,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": ["<string>"],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": ["<string>"]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": True,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": True,
"videoRecordingEnabled": True,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": ["<string>"],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": True,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": True,
"controlEnabled": True
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": True,
"languageDetectionEnabled": True,
"keywords": ["<string>"],
"endpointing": 123
},
"dialKeypadFunctionEnabled": True,
"endCallFunctionEnabled": True,
"forwardingPhoneNumber": "<string>",
"variableValues": {}
},
"squadId": "<string>",
"squad": {
"name": "<string>",
"assistants": [
{
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": False,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": False,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": ["<string>"]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": ["<string>"],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": ["<string>"],
"provider": "canonical"
},
"fallbackModels": ["standard"],
"semanticCachingEnabled": True,
"emotionRecognitionEnabled": True
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": True,
"minCharacters": 30,
"punctuationBoundaries": ["<string>"],
"formatPlan": {
"enabled": True,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": True,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": False,
"enableSsmlParsing": False,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": False,
"clientMessages": ["<string>"],
"serverMessages": ["end-of-call-report"],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": True,
"modelOutputInMessagesEnabled": True,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": True
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": True,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": ["<string>"],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": ["<string>"]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": True,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": True,
"videoRecordingEnabled": True,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": ["<string>"],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": True,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": True,
"controlEnabled": True
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": True,
"languageDetectionEnabled": True,
"keywords": ["<string>"],
"endpointing": 123
},
"dialKeypadFunctionEnabled": True,
"endCallFunctionEnabled": True,
"forwardingPhoneNumber": "<string>"
}
]
},
"phoneNumberId": "<string>",
"phoneNumber": {
"number": "<string>",
"twilioAccountSid": "<string>",
"twilioAuthToken": "<string>",
"provider": "twilio",
"name": "<string>",
"assistantId": "<string>",
"squadId": "<string>",
"fallbackDestination": {
"number": "<string>",
"type": "number",
"extension": "<string>",
"callerId": "<string>",
"message": "<string>",
"description": "<string>",
"numberE164CheckEnabled": True
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"customerId": "<string>",
"customer": {
"extension": "<string>",
"number": "<string>",
"sipUri": "<string>",
"name": "<string>",
"numberE164CheckEnabled": True
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
assistantId: '<string>',
assistant: {
name: '<string>',
model: {
messages: [{content: '<string>', role: '<string>'}],
provider: 'standard',
model: 'standard',
tools: [
{
type: 'dtmf',
async: false,
messages: [
{
type: 'request-start',
contents: [{type: 'text', text: '<string>'}],
content: '<string>',
conditions: [{param: '<string>', value: {}}]
}
],
function: {
name: '<string>',
strict: false,
description: '<string>',
parameters: {type: 'object', properties: {}, required: ['<string>']}
},
server: {url: '<string>', timeoutSeconds: 20, secret: '<string>', headers: {}}
}
],
toolIds: ['<string>'],
temperature: 123,
maxTokens: 123,
numFastTurns: 123,
knowledgeBase: {topK: 123, fileIds: ['<string>'], provider: 'canonical'},
fallbackModels: ['standard'],
semanticCachingEnabled: true,
emotionRecognitionEnabled: true
},
voice: {
model: 'standard',
style: 123,
language: '<string>',
chunkPlan: {
enabled: true,
minCharacters: 30,
punctuationBoundaries: ['<string>'],
formatPlan: {
enabled: true,
numberToDigitsCutoff: 2025,
replacements: [{key: '<string>', value: '<string>', type: 'exact'}]
}
},
fillerInjectionEnabled: true,
provider: 'standard',
stability: 123,
similarityBoost: 123,
useSpeakerBoost: false,
enableSsmlParsing: false,
optimizeStreamingLatency: 3
},
hipaaEnabled: false,
clientMessages: ['<string>'],
serverMessages: ['end-of-call-report'],
silenceTimeoutSeconds: 123,
maxDurationSeconds: 123,
backgroundDenoisingEnabled: true,
modelOutputInMessagesEnabled: true,
transportConfigurations: [{provider: 'twilio', timeout: 123, record: true}],
firstMessage: '<string>',
voicemailDetection: {
enabled: true,
provider: '<string>',
machineDetectionTimeout: 123,
voicemailDetectionTypes: ['machine_end_beep', 'machine_end_silence'],
machineDetectionSilenceTimeout: 123,
machineDetectionSpeechThreshold: 123,
machineDetectionSpeechEndThreshold: 123
},
voicemailMessage: '',
endCallMessage: '<string>',
endCallPhrases: ['<string>'],
metadata: {},
serverUrl: '<string>',
serverUrlSecret: '<string>',
analysisPlan: {
successEvaluationRequestTimeoutSeconds: 123,
successEvaluationPrompt: '<string>',
structuredDataSchema: {items: {}, properties: {}, description: '<string>', required: ['<string>']},
structuredDataRequestTimeoutSeconds: 123,
structuredDataPrompt: '<string>',
summaryPrompt: '<string>',
summaryRequestTimeoutSeconds: 123
},
artifactPlan: {
transcriptPlan: {enabled: true, userName: '<string>', assistantName: '<string>'},
recordingEnabled: true,
videoRecordingEnabled: true,
recordingPath: '<string>'
},
messagePlan: {
idleMessages: ['<string>'],
idleMessageMaxSpokenCount: 123,
idleTimeoutSeconds: 123
},
startSpeakingPlan: {
waitSeconds: 123,
smartEndpointingEnabled: true,
transcriptionEndpointingPlan: {onPunctuationSeconds: 123, onNoPunctuationSeconds: 123, onNumberSeconds: 123}
},
stopSpeakingPlan: {numWords: 123, voiceSeconds: 123, backoffSeconds: 123},
monitorPlan: {listenEnabled: true, controlEnabled: true},
transcriber: {
provider: 'standard',
model: 'standard',
language: '<string>',
smartFormat: true,
languageDetectionEnabled: true,
keywords: ['<string>'],
endpointing: 123
},
dialKeypadFunctionEnabled: true,
endCallFunctionEnabled: true,
forwardingPhoneNumber: '<string>'
},
assistantOverrides: {
name: '<string>',
model: {
messages: [{content: '<string>', role: '<string>'}],
provider: 'standard',
model: 'standard',
tools: [
{
type: 'dtmf',
async: false,
messages: [
{
type: 'request-start',
contents: [{type: 'text', text: '<string>'}],
content: '<string>',
conditions: [{param: '<string>', value: {}}]
}
],
function: {
name: '<string>',
strict: false,
description: '<string>',
parameters: {type: 'object', properties: {}, required: ['<string>']}
},
server: {url: '<string>', timeoutSeconds: 20, secret: '<string>', headers: {}}
}
],
toolIds: ['<string>'],
temperature: 123,
maxTokens: 123,
numFastTurns: 123,
knowledgeBase: {topK: 123, fileIds: ['<string>'], provider: 'canonical'},
fallbackModels: ['standard'],
semanticCachingEnabled: true,
emotionRecognitionEnabled: true
},
voice: {
model: 'standard',
style: 123,
language: '<string>',
chunkPlan: {
enabled: true,
minCharacters: 30,
punctuationBoundaries: ['<string>'],
formatPlan: {
enabled: true,
numberToDigitsCutoff: 2025,
replacements: [{key: '<string>', value: '<string>', type: 'exact'}]
}
},
fillerInjectionEnabled: true,
provider: 'standard',
stability: 123,
similarityBoost: 123,
useSpeakerBoost: false,
enableSsmlParsing: false,
optimizeStreamingLatency: 3
},
hipaaEnabled: false,
clientMessages: ['<string>'],
serverMessages: ['end-of-call-report'],
silenceTimeoutSeconds: 123,
maxDurationSeconds: 123,
backgroundDenoisingEnabled: true,
modelOutputInMessagesEnabled: true,
transportConfigurations: [{provider: 'twilio', timeout: 123, record: true}],
firstMessage: '<string>',
voicemailDetection: {
enabled: true,
provider: '<string>',
machineDetectionTimeout: 123,
voicemailDetectionTypes: ['machine_end_beep', 'machine_end_silence'],
machineDetectionSilenceTimeout: 123,
machineDetectionSpeechThreshold: 123,
machineDetectionSpeechEndThreshold: 123
},
voicemailMessage: '',
endCallMessage: '<string>',
endCallPhrases: ['<string>'],
metadata: {},
serverUrl: '<string>',
serverUrlSecret: '<string>',
analysisPlan: {
successEvaluationRequestTimeoutSeconds: 123,
successEvaluationPrompt: '<string>',
structuredDataSchema: {items: {}, properties: {}, description: '<string>', required: ['<string>']},
structuredDataRequestTimeoutSeconds: 123,
structuredDataPrompt: '<string>',
summaryPrompt: '<string>',
summaryRequestTimeoutSeconds: 123
},
artifactPlan: {
transcriptPlan: {enabled: true, userName: '<string>', assistantName: '<string>'},
recordingEnabled: true,
videoRecordingEnabled: true,
recordingPath: '<string>'
},
messagePlan: {
idleMessages: ['<string>'],
idleMessageMaxSpokenCount: 123,
idleTimeoutSeconds: 123
},
startSpeakingPlan: {
waitSeconds: 123,
smartEndpointingEnabled: true,
transcriptionEndpointingPlan: {onPunctuationSeconds: 123, onNoPunctuationSeconds: 123, onNumberSeconds: 123}
},
stopSpeakingPlan: {numWords: 123, voiceSeconds: 123, backoffSeconds: 123},
monitorPlan: {listenEnabled: true, controlEnabled: true},
transcriber: {
provider: 'standard',
model: 'standard',
language: '<string>',
smartFormat: true,
languageDetectionEnabled: true,
keywords: ['<string>'],
endpointing: 123
},
dialKeypadFunctionEnabled: true,
endCallFunctionEnabled: true,
forwardingPhoneNumber: '<string>',
variableValues: {}
},
squadId: '<string>',
squad: {
name: '<string>',
assistants: [
{
name: '<string>',
model: {
messages: [{content: '<string>', role: '<string>'}],
provider: 'standard',
model: 'standard',
tools: [
{
type: 'dtmf',
async: false,
messages: [
{
type: 'request-start',
contents: [{type: 'text', text: '<string>'}],
content: '<string>',
conditions: [{param: '<string>', value: {}}]
}
],
function: {
name: '<string>',
strict: false,
description: '<string>',
parameters: {type: 'object', properties: {}, required: ['<string>']}
},
server: {url: '<string>', timeoutSeconds: 20, secret: '<string>', headers: {}}
}
],
toolIds: ['<string>'],
temperature: 123,
maxTokens: 123,
numFastTurns: 123,
knowledgeBase: {topK: 123, fileIds: ['<string>'], provider: 'canonical'},
fallbackModels: ['standard'],
semanticCachingEnabled: true,
emotionRecognitionEnabled: true
},
voice: {
model: 'standard',
style: 123,
language: '<string>',
chunkPlan: {
enabled: true,
minCharacters: 30,
punctuationBoundaries: ['<string>'],
formatPlan: {
enabled: true,
numberToDigitsCutoff: 2025,
replacements: [{key: '<string>', value: '<string>', type: 'exact'}]
}
},
fillerInjectionEnabled: true,
provider: 'standard',
stability: 123,
similarityBoost: 123,
useSpeakerBoost: false,
enableSsmlParsing: false,
optimizeStreamingLatency: 3
},
hipaaEnabled: false,
clientMessages: ['<string>'],
serverMessages: ['end-of-call-report'],
silenceTimeoutSeconds: 123,
maxDurationSeconds: 123,
backgroundDenoisingEnabled: true,
modelOutputInMessagesEnabled: true,
transportConfigurations: [{provider: 'twilio', timeout: 123, record: true}],
firstMessage: '<string>',
voicemailDetection: {
enabled: true,
provider: '<string>',
machineDetectionTimeout: 123,
voicemailDetectionTypes: ['machine_end_beep', 'machine_end_silence'],
machineDetectionSilenceTimeout: 123,
machineDetectionSpeechThreshold: 123,
machineDetectionSpeechEndThreshold: 123
},
voicemailMessage: '',
endCallMessage: '<string>',
endCallPhrases: ['<string>'],
metadata: {},
serverUrl: '<string>',
serverUrlSecret: '<string>',
analysisPlan: {
successEvaluationRequestTimeoutSeconds: 123,
successEvaluationPrompt: '<string>',
structuredDataSchema: {items: {}, properties: {}, description: '<string>', required: ['<string>']},
structuredDataRequestTimeoutSeconds: 123,
structuredDataPrompt: '<string>',
summaryPrompt: '<string>',
summaryRequestTimeoutSeconds: 123
},
artifactPlan: {
transcriptPlan: {enabled: true, userName: '<string>', assistantName: '<string>'},
recordingEnabled: true,
videoRecordingEnabled: true,
recordingPath: '<string>'
},
messagePlan: {
idleMessages: ['<string>'],
idleMessageMaxSpokenCount: 123,
idleTimeoutSeconds: 123
},
startSpeakingPlan: {
waitSeconds: 123,
smartEndpointingEnabled: true,
transcriptionEndpointingPlan: {onPunctuationSeconds: 123, onNoPunctuationSeconds: 123, onNumberSeconds: 123}
},
stopSpeakingPlan: {numWords: 123, voiceSeconds: 123, backoffSeconds: 123},
monitorPlan: {listenEnabled: true, controlEnabled: true},
transcriber: {
provider: 'standard',
model: 'standard',
language: '<string>',
smartFormat: true,
languageDetectionEnabled: true,
keywords: ['<string>'],
endpointing: 123
},
dialKeypadFunctionEnabled: true,
endCallFunctionEnabled: true,
forwardingPhoneNumber: '<string>'
}
]
},
phoneNumberId: '<string>',
phoneNumber: {
number: '<string>',
twilioAccountSid: '<string>',
twilioAuthToken: '<string>',
provider: 'twilio',
name: '<string>',
assistantId: '<string>',
squadId: '<string>',
fallbackDestination: {
number: '<string>',
type: 'number',
extension: '<string>',
callerId: '<string>',
message: '<string>',
description: '<string>',
numberE164CheckEnabled: true
},
serverUrl: '<string>',
serverUrlSecret: '<string>'
},
customerId: '<string>',
customer: {
extension: '<string>',
number: '<string>',
sipUri: '<string>',
name: '<string>',
numberE164CheckEnabled: true
}
})
};
fetch('https://api.voicebot.studio/api/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voicebot.studio/api/v1/calls"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"assistantId\": \"<string>\",\n \"assistant\": {\n \"name\": \"<string>\",\n \"model\": {\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"tools\": [\n {\n \"type\": \"dtmf\",\n \"async\": false,\n \"messages\": [\n {\n \"type\": \"request-start\",\n \"contents\": [\n {\n \"type\": \"text\",\n \"text\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"conditions\": [\n {\n \"param\": \"<string>\",\n \"value\": {}\n }\n ]\n }\n ],\n \"function\": {\n \"name\": \"<string>\",\n \"strict\": false,\n \"description\": \"<string>\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {},\n \"required\": [\n \"<string>\"\n ]\n }\n },\n \"server\": {\n \"url\": \"<string>\",\n \"timeoutSeconds\": 20,\n \"secret\": \"<string>\",\n \"headers\": {}\n }\n }\n ],\n \"toolIds\": [\n \"<string>\"\n ],\n \"temperature\": 123,\n \"maxTokens\": 123,\n \"numFastTurns\": 123,\n \"knowledgeBase\": {\n \"topK\": 123,\n \"fileIds\": [\n \"<string>\"\n ],\n \"provider\": \"canonical\"\n },\n \"fallbackModels\": [\n \"standard\"\n ],\n \"semanticCachingEnabled\": true,\n \"emotionRecognitionEnabled\": true\n },\n \"voice\": {\n \"model\": \"standard\",\n \"style\": 123,\n \"language\": \"<string>\",\n \"chunkPlan\": {\n \"enabled\": true,\n \"minCharacters\": 30,\n \"punctuationBoundaries\": [\n \"<string>\"\n ],\n \"formatPlan\": {\n \"enabled\": true,\n \"numberToDigitsCutoff\": 2025,\n \"replacements\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"type\": \"exact\"\n }\n ]\n }\n },\n \"fillerInjectionEnabled\": true,\n \"provider\": \"standard\",\n \"stability\": 123,\n \"similarityBoost\": 123,\n \"useSpeakerBoost\": false,\n \"enableSsmlParsing\": false,\n \"optimizeStreamingLatency\": 3\n },\n \"hipaaEnabled\": false,\n \"clientMessages\": [\n \"<string>\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\"\n ],\n \"silenceTimeoutSeconds\": 123,\n \"maxDurationSeconds\": 123,\n \"backgroundDenoisingEnabled\": true,\n \"modelOutputInMessagesEnabled\": true,\n \"transportConfigurations\": [\n {\n \"provider\": \"twilio\",\n \"timeout\": 123,\n \"record\": true\n }\n ],\n \"firstMessage\": \"<string>\",\n \"voicemailDetection\": {\n \"enabled\": true,\n \"provider\": \"<string>\",\n \"machineDetectionTimeout\": 123,\n \"voicemailDetectionTypes\": [\n \"machine_end_beep\",\n \"machine_end_silence\"\n ],\n \"machineDetectionSilenceTimeout\": 123,\n \"machineDetectionSpeechThreshold\": 123,\n \"machineDetectionSpeechEndThreshold\": 123\n },\n \"voicemailMessage\": \"\",\n \"endCallMessage\": \"<string>\",\n \"endCallPhrases\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\",\n \"analysisPlan\": {\n \"successEvaluationRequestTimeoutSeconds\": 123,\n \"successEvaluationPrompt\": \"<string>\",\n \"structuredDataSchema\": {\n \"items\": {},\n \"properties\": {},\n \"description\": \"<string>\",\n \"required\": [\n \"<string>\"\n ]\n },\n \"structuredDataRequestTimeoutSeconds\": 123,\n \"structuredDataPrompt\": \"<string>\",\n \"summaryPrompt\": \"<string>\",\n \"summaryRequestTimeoutSeconds\": 123\n },\n \"artifactPlan\": {\n \"transcriptPlan\": {\n \"enabled\": true,\n \"userName\": \"<string>\",\n \"assistantName\": \"<string>\"\n },\n \"recordingEnabled\": true,\n \"videoRecordingEnabled\": true,\n \"recordingPath\": \"<string>\"\n },\n \"messagePlan\": {\n \"idleMessages\": [\n \"<string>\"\n ],\n \"idleMessageMaxSpokenCount\": 123,\n \"idleTimeoutSeconds\": 123\n },\n \"startSpeakingPlan\": {\n \"waitSeconds\": 123,\n \"smartEndpointingEnabled\": true,\n \"transcriptionEndpointingPlan\": {\n \"onPunctuationSeconds\": 123,\n \"onNoPunctuationSeconds\": 123,\n \"onNumberSeconds\": 123\n }\n },\n \"stopSpeakingPlan\": {\n \"numWords\": 123,\n \"voiceSeconds\": 123,\n \"backoffSeconds\": 123\n },\n \"monitorPlan\": {\n \"listenEnabled\": true,\n \"controlEnabled\": true\n },\n \"transcriber\": {\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"language\": \"<string>\",\n \"smartFormat\": true,\n \"languageDetectionEnabled\": true,\n \"keywords\": [\n \"<string>\"\n ],\n \"endpointing\": 123\n },\n \"dialKeypadFunctionEnabled\": true,\n \"endCallFunctionEnabled\": true,\n \"forwardingPhoneNumber\": \"<string>\"\n },\n \"assistantOverrides\": {\n \"name\": \"<string>\",\n \"model\": {\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"tools\": [\n {\n \"type\": \"dtmf\",\n \"async\": false,\n \"messages\": [\n {\n \"type\": \"request-start\",\n \"contents\": [\n {\n \"type\": \"text\",\n \"text\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"conditions\": [\n {\n \"param\": \"<string>\",\n \"value\": {}\n }\n ]\n }\n ],\n \"function\": {\n \"name\": \"<string>\",\n \"strict\": false,\n \"description\": \"<string>\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {},\n \"required\": [\n \"<string>\"\n ]\n }\n },\n \"server\": {\n \"url\": \"<string>\",\n \"timeoutSeconds\": 20,\n \"secret\": \"<string>\",\n \"headers\": {}\n }\n }\n ],\n \"toolIds\": [\n \"<string>\"\n ],\n \"temperature\": 123,\n \"maxTokens\": 123,\n \"numFastTurns\": 123,\n \"knowledgeBase\": {\n \"topK\": 123,\n \"fileIds\": [\n \"<string>\"\n ],\n \"provider\": \"canonical\"\n },\n \"fallbackModels\": [\n \"standard\"\n ],\n \"semanticCachingEnabled\": true,\n \"emotionRecognitionEnabled\": true\n },\n \"voice\": {\n \"model\": \"standard\",\n \"style\": 123,\n \"language\": \"<string>\",\n \"chunkPlan\": {\n \"enabled\": true,\n \"minCharacters\": 30,\n \"punctuationBoundaries\": [\n \"<string>\"\n ],\n \"formatPlan\": {\n \"enabled\": true,\n \"numberToDigitsCutoff\": 2025,\n \"replacements\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"type\": \"exact\"\n }\n ]\n }\n },\n \"fillerInjectionEnabled\": true,\n \"provider\": \"standard\",\n \"stability\": 123,\n \"similarityBoost\": 123,\n \"useSpeakerBoost\": false,\n \"enableSsmlParsing\": false,\n \"optimizeStreamingLatency\": 3\n },\n \"hipaaEnabled\": false,\n \"clientMessages\": [\n \"<string>\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\"\n ],\n \"silenceTimeoutSeconds\": 123,\n \"maxDurationSeconds\": 123,\n \"backgroundDenoisingEnabled\": true,\n \"modelOutputInMessagesEnabled\": true,\n \"transportConfigurations\": [\n {\n \"provider\": \"twilio\",\n \"timeout\": 123,\n \"record\": true\n }\n ],\n \"firstMessage\": \"<string>\",\n \"voicemailDetection\": {\n \"enabled\": true,\n \"provider\": \"<string>\",\n \"machineDetectionTimeout\": 123,\n \"voicemailDetectionTypes\": [\n \"machine_end_beep\",\n \"machine_end_silence\"\n ],\n \"machineDetectionSilenceTimeout\": 123,\n \"machineDetectionSpeechThreshold\": 123,\n \"machineDetectionSpeechEndThreshold\": 123\n },\n \"voicemailMessage\": \"\",\n \"endCallMessage\": \"<string>\",\n \"endCallPhrases\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\",\n \"analysisPlan\": {\n \"successEvaluationRequestTimeoutSeconds\": 123,\n \"successEvaluationPrompt\": \"<string>\",\n \"structuredDataSchema\": {\n \"items\": {},\n \"properties\": {},\n \"description\": \"<string>\",\n \"required\": [\n \"<string>\"\n ]\n },\n \"structuredDataRequestTimeoutSeconds\": 123,\n \"structuredDataPrompt\": \"<string>\",\n \"summaryPrompt\": \"<string>\",\n \"summaryRequestTimeoutSeconds\": 123\n },\n \"artifactPlan\": {\n \"transcriptPlan\": {\n \"enabled\": true,\n \"userName\": \"<string>\",\n \"assistantName\": \"<string>\"\n },\n \"recordingEnabled\": true,\n \"videoRecordingEnabled\": true,\n \"recordingPath\": \"<string>\"\n },\n \"messagePlan\": {\n \"idleMessages\": [\n \"<string>\"\n ],\n \"idleMessageMaxSpokenCount\": 123,\n \"idleTimeoutSeconds\": 123\n },\n \"startSpeakingPlan\": {\n \"waitSeconds\": 123,\n \"smartEndpointingEnabled\": true,\n \"transcriptionEndpointingPlan\": {\n \"onPunctuationSeconds\": 123,\n \"onNoPunctuationSeconds\": 123,\n \"onNumberSeconds\": 123\n }\n },\n \"stopSpeakingPlan\": {\n \"numWords\": 123,\n \"voiceSeconds\": 123,\n \"backoffSeconds\": 123\n },\n \"monitorPlan\": {\n \"listenEnabled\": true,\n \"controlEnabled\": true\n },\n \"transcriber\": {\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"language\": \"<string>\",\n \"smartFormat\": true,\n \"languageDetectionEnabled\": true,\n \"keywords\": [\n \"<string>\"\n ],\n \"endpointing\": 123\n },\n \"dialKeypadFunctionEnabled\": true,\n \"endCallFunctionEnabled\": true,\n \"forwardingPhoneNumber\": \"<string>\",\n \"variableValues\": {}\n },\n \"squadId\": \"<string>\",\n \"squad\": {\n \"name\": \"<string>\",\n \"assistants\": [\n {\n \"name\": \"<string>\",\n \"model\": {\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"tools\": [\n {\n \"type\": \"dtmf\",\n \"async\": false,\n \"messages\": [\n {\n \"type\": \"request-start\",\n \"contents\": [\n {\n \"type\": \"text\",\n \"text\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"conditions\": [\n {\n \"param\": \"<string>\",\n \"value\": {}\n }\n ]\n }\n ],\n \"function\": {\n \"name\": \"<string>\",\n \"strict\": false,\n \"description\": \"<string>\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {},\n \"required\": [\n \"<string>\"\n ]\n }\n },\n \"server\": {\n \"url\": \"<string>\",\n \"timeoutSeconds\": 20,\n \"secret\": \"<string>\",\n \"headers\": {}\n }\n }\n ],\n \"toolIds\": [\n \"<string>\"\n ],\n \"temperature\": 123,\n \"maxTokens\": 123,\n \"numFastTurns\": 123,\n \"knowledgeBase\": {\n \"topK\": 123,\n \"fileIds\": [\n \"<string>\"\n ],\n \"provider\": \"canonical\"\n },\n \"fallbackModels\": [\n \"standard\"\n ],\n \"semanticCachingEnabled\": true,\n \"emotionRecognitionEnabled\": true\n },\n \"voice\": {\n \"model\": \"standard\",\n \"style\": 123,\n \"language\": \"<string>\",\n \"chunkPlan\": {\n \"enabled\": true,\n \"minCharacters\": 30,\n \"punctuationBoundaries\": [\n \"<string>\"\n ],\n \"formatPlan\": {\n \"enabled\": true,\n \"numberToDigitsCutoff\": 2025,\n \"replacements\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"type\": \"exact\"\n }\n ]\n }\n },\n \"fillerInjectionEnabled\": true,\n \"provider\": \"standard\",\n \"stability\": 123,\n \"similarityBoost\": 123,\n \"useSpeakerBoost\": false,\n \"enableSsmlParsing\": false,\n \"optimizeStreamingLatency\": 3\n },\n \"hipaaEnabled\": false,\n \"clientMessages\": [\n \"<string>\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\"\n ],\n \"silenceTimeoutSeconds\": 123,\n \"maxDurationSeconds\": 123,\n \"backgroundDenoisingEnabled\": true,\n \"modelOutputInMessagesEnabled\": true,\n \"transportConfigurations\": [\n {\n \"provider\": \"twilio\",\n \"timeout\": 123,\n \"record\": true\n }\n ],\n \"firstMessage\": \"<string>\",\n \"voicemailDetection\": {\n \"enabled\": true,\n \"provider\": \"<string>\",\n \"machineDetectionTimeout\": 123,\n \"voicemailDetectionTypes\": [\n \"machine_end_beep\",\n \"machine_end_silence\"\n ],\n \"machineDetectionSilenceTimeout\": 123,\n \"machineDetectionSpeechThreshold\": 123,\n \"machineDetectionSpeechEndThreshold\": 123\n },\n \"voicemailMessage\": \"\",\n \"endCallMessage\": \"<string>\",\n \"endCallPhrases\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\",\n \"analysisPlan\": {\n \"successEvaluationRequestTimeoutSeconds\": 123,\n \"successEvaluationPrompt\": \"<string>\",\n \"structuredDataSchema\": {\n \"items\": {},\n \"properties\": {},\n \"description\": \"<string>\",\n \"required\": [\n \"<string>\"\n ]\n },\n \"structuredDataRequestTimeoutSeconds\": 123,\n \"structuredDataPrompt\": \"<string>\",\n \"summaryPrompt\": \"<string>\",\n \"summaryRequestTimeoutSeconds\": 123\n },\n \"artifactPlan\": {\n \"transcriptPlan\": {\n \"enabled\": true,\n \"userName\": \"<string>\",\n \"assistantName\": \"<string>\"\n },\n \"recordingEnabled\": true,\n \"videoRecordingEnabled\": true,\n \"recordingPath\": \"<string>\"\n },\n \"messagePlan\": {\n \"idleMessages\": [\n \"<string>\"\n ],\n \"idleMessageMaxSpokenCount\": 123,\n \"idleTimeoutSeconds\": 123\n },\n \"startSpeakingPlan\": {\n \"waitSeconds\": 123,\n \"smartEndpointingEnabled\": true,\n \"transcriptionEndpointingPlan\": {\n \"onPunctuationSeconds\": 123,\n \"onNoPunctuationSeconds\": 123,\n \"onNumberSeconds\": 123\n }\n },\n \"stopSpeakingPlan\": {\n \"numWords\": 123,\n \"voiceSeconds\": 123,\n \"backoffSeconds\": 123\n },\n \"monitorPlan\": {\n \"listenEnabled\": true,\n \"controlEnabled\": true\n },\n \"transcriber\": {\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"language\": \"<string>\",\n \"smartFormat\": true,\n \"languageDetectionEnabled\": true,\n \"keywords\": [\n \"<string>\"\n ],\n \"endpointing\": 123\n },\n \"dialKeypadFunctionEnabled\": true,\n \"endCallFunctionEnabled\": true,\n \"forwardingPhoneNumber\": \"<string>\"\n }\n ]\n },\n \"phoneNumberId\": \"<string>\",\n \"phoneNumber\": {\n \"number\": \"<string>\",\n \"twilioAccountSid\": \"<string>\",\n \"twilioAuthToken\": \"<string>\",\n \"provider\": \"twilio\",\n \"name\": \"<string>\",\n \"assistantId\": \"<string>\",\n \"squadId\": \"<string>\",\n \"fallbackDestination\": {\n \"number\": \"<string>\",\n \"type\": \"number\",\n \"extension\": \"<string>\",\n \"callerId\": \"<string>\",\n \"message\": \"<string>\",\n \"description\": \"<string>\",\n \"numberE164CheckEnabled\": true\n },\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"customer\": {\n \"extension\": \"<string>\",\n \"number\": \"<string>\",\n \"sipUri\": \"<string>\",\n \"name\": \"<string>\",\n \"numberE164CheckEnabled\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "<string>",
"type": "<string>",
"messages": [
{
"secondsFromStart": 123,
"role": "<string>",
"message": "<string>",
"time": 123,
"endTime": 123,
"source": "<string>",
"duration": 123
}
],
"phoneCallProvider": "<string>",
"phoneCallTransport": "<string>",
"status": "<string>",
"endedReason": "<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",
"analysis": {
"summary": "<string>",
"successEvaluation": "<string>"
},
"phoneCallProviderId": "<string>",
"assistantId": "<string>",
"phoneNumberId": "<string>",
"customer": {},
"transcript": "<string>",
"recordingUrl": "<string>",
"summary": "<string>",
"stereoRecordingUrl": "<string>",
"transport": {},
"organizationId": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Calls
Create Call
Create a new call using the voicebot API.
The endpoint builds a payload from the request data (with camelCase keys), posts it to the voicebot API, stores the response in MongoDB, and returns the API response.
POST
/
api
/
v1
/
calls
Create Call
curl --request POST \
--url https://api.voicebot.studio/api/v1/calls \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"assistantId": "<string>",
"assistant": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": false,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": [
"<string>"
],
"provider": "canonical"
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": true,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": false,
"enableSsmlParsing": false,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": false,
"clientMessages": [
"<string>"
],
"serverMessages": [
"end-of-call-report"
],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": true,
"modelOutputInMessagesEnabled": true,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": true
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": true,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": [
"machine_end_beep",
"machine_end_silence"
],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": true,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": true,
"videoRecordingEnabled": true,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": true,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": true,
"controlEnabled": true
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>"
},
"assistantOverrides": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": false,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": [
"<string>"
],
"provider": "canonical"
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": true,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": false,
"enableSsmlParsing": false,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": false,
"clientMessages": [
"<string>"
],
"serverMessages": [
"end-of-call-report"
],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": true,
"modelOutputInMessagesEnabled": true,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": true
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": true,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": [
"machine_end_beep",
"machine_end_silence"
],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": true,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": true,
"videoRecordingEnabled": true,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": true,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": true,
"controlEnabled": true
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>",
"variableValues": {}
},
"squadId": "<string>",
"squad": {
"name": "<string>",
"assistants": [
{
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": false,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": [
"<string>"
],
"provider": "canonical"
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": true,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": false,
"enableSsmlParsing": false,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": false,
"clientMessages": [
"<string>"
],
"serverMessages": [
"end-of-call-report"
],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": true,
"modelOutputInMessagesEnabled": true,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": true
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": true,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": [
"machine_end_beep",
"machine_end_silence"
],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": true,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": true,
"videoRecordingEnabled": true,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": true,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": true,
"controlEnabled": true
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>"
}
]
},
"phoneNumberId": "<string>",
"phoneNumber": {
"number": "<string>",
"twilioAccountSid": "<string>",
"twilioAuthToken": "<string>",
"provider": "twilio",
"name": "<string>",
"assistantId": "<string>",
"squadId": "<string>",
"fallbackDestination": {
"number": "<string>",
"type": "number",
"extension": "<string>",
"callerId": "<string>",
"message": "<string>",
"description": "<string>",
"numberE164CheckEnabled": true
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"customerId": "<string>",
"customer": {
"extension": "<string>",
"number": "<string>",
"sipUri": "<string>",
"name": "<string>",
"numberE164CheckEnabled": true
}
}
'import requests
url = "https://api.voicebot.studio/api/v1/calls"
payload = {
"name": "<string>",
"assistantId": "<string>",
"assistant": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": False,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": False,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": ["<string>"]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": ["<string>"],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": ["<string>"],
"provider": "canonical"
},
"fallbackModels": ["standard"],
"semanticCachingEnabled": True,
"emotionRecognitionEnabled": True
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": True,
"minCharacters": 30,
"punctuationBoundaries": ["<string>"],
"formatPlan": {
"enabled": True,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": True,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": False,
"enableSsmlParsing": False,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": False,
"clientMessages": ["<string>"],
"serverMessages": ["end-of-call-report"],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": True,
"modelOutputInMessagesEnabled": True,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": True
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": True,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": ["<string>"],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": ["<string>"]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": True,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": True,
"videoRecordingEnabled": True,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": ["<string>"],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": True,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": True,
"controlEnabled": True
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": True,
"languageDetectionEnabled": True,
"keywords": ["<string>"],
"endpointing": 123
},
"dialKeypadFunctionEnabled": True,
"endCallFunctionEnabled": True,
"forwardingPhoneNumber": "<string>"
},
"assistantOverrides": {
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": False,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": False,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": ["<string>"]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": ["<string>"],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": ["<string>"],
"provider": "canonical"
},
"fallbackModels": ["standard"],
"semanticCachingEnabled": True,
"emotionRecognitionEnabled": True
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": True,
"minCharacters": 30,
"punctuationBoundaries": ["<string>"],
"formatPlan": {
"enabled": True,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": True,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": False,
"enableSsmlParsing": False,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": False,
"clientMessages": ["<string>"],
"serverMessages": ["end-of-call-report"],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": True,
"modelOutputInMessagesEnabled": True,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": True
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": True,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": ["<string>"],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": ["<string>"]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": True,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": True,
"videoRecordingEnabled": True,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": ["<string>"],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": True,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": True,
"controlEnabled": True
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": True,
"languageDetectionEnabled": True,
"keywords": ["<string>"],
"endpointing": 123
},
"dialKeypadFunctionEnabled": True,
"endCallFunctionEnabled": True,
"forwardingPhoneNumber": "<string>",
"variableValues": {}
},
"squadId": "<string>",
"squad": {
"name": "<string>",
"assistants": [
{
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"type": "dtmf",
"async": False,
"messages": [
{
"type": "request-start",
"contents": [
{
"type": "text",
"text": "<string>"
}
],
"content": "<string>",
"conditions": [
{
"param": "<string>",
"value": {}
}
]
}
],
"function": {
"name": "<string>",
"strict": False,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": ["<string>"]
}
},
"server": {
"url": "<string>",
"timeoutSeconds": 20,
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": ["<string>"],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"topK": 123,
"fileIds": ["<string>"],
"provider": "canonical"
},
"fallbackModels": ["standard"],
"semanticCachingEnabled": True,
"emotionRecognitionEnabled": True
},
"voice": {
"model": "standard",
"style": 123,
"language": "<string>",
"chunkPlan": {
"enabled": True,
"minCharacters": 30,
"punctuationBoundaries": ["<string>"],
"formatPlan": {
"enabled": True,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"key": "<string>",
"value": "<string>",
"type": "exact"
}
]
}
},
"fillerInjectionEnabled": True,
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": False,
"enableSsmlParsing": False,
"optimizeStreamingLatency": 3
},
"hipaaEnabled": False,
"clientMessages": ["<string>"],
"serverMessages": ["end-of-call-report"],
"silenceTimeoutSeconds": 123,
"maxDurationSeconds": 123,
"backgroundDenoisingEnabled": True,
"modelOutputInMessagesEnabled": True,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 123,
"record": True
}
],
"firstMessage": "<string>",
"voicemailDetection": {
"enabled": True,
"provider": "<string>",
"machineDetectionTimeout": 123,
"voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"],
"machineDetectionSilenceTimeout": 123,
"machineDetectionSpeechThreshold": 123,
"machineDetectionSpeechEndThreshold": 123
},
"voicemailMessage": "",
"endCallMessage": "<string>",
"endCallPhrases": ["<string>"],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"analysisPlan": {
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"items": {},
"properties": {},
"description": "<string>",
"required": ["<string>"]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"artifactPlan": {
"transcriptPlan": {
"enabled": True,
"userName": "<string>",
"assistantName": "<string>"
},
"recordingEnabled": True,
"videoRecordingEnabled": True,
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": ["<string>"],
"idleMessageMaxSpokenCount": 123,
"idleTimeoutSeconds": 123
},
"startSpeakingPlan": {
"waitSeconds": 123,
"smartEndpointingEnabled": True,
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 123,
"onNoPunctuationSeconds": 123,
"onNumberSeconds": 123
}
},
"stopSpeakingPlan": {
"numWords": 123,
"voiceSeconds": 123,
"backoffSeconds": 123
},
"monitorPlan": {
"listenEnabled": True,
"controlEnabled": True
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": True,
"languageDetectionEnabled": True,
"keywords": ["<string>"],
"endpointing": 123
},
"dialKeypadFunctionEnabled": True,
"endCallFunctionEnabled": True,
"forwardingPhoneNumber": "<string>"
}
]
},
"phoneNumberId": "<string>",
"phoneNumber": {
"number": "<string>",
"twilioAccountSid": "<string>",
"twilioAuthToken": "<string>",
"provider": "twilio",
"name": "<string>",
"assistantId": "<string>",
"squadId": "<string>",
"fallbackDestination": {
"number": "<string>",
"type": "number",
"extension": "<string>",
"callerId": "<string>",
"message": "<string>",
"description": "<string>",
"numberE164CheckEnabled": True
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"customerId": "<string>",
"customer": {
"extension": "<string>",
"number": "<string>",
"sipUri": "<string>",
"name": "<string>",
"numberE164CheckEnabled": True
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
assistantId: '<string>',
assistant: {
name: '<string>',
model: {
messages: [{content: '<string>', role: '<string>'}],
provider: 'standard',
model: 'standard',
tools: [
{
type: 'dtmf',
async: false,
messages: [
{
type: 'request-start',
contents: [{type: 'text', text: '<string>'}],
content: '<string>',
conditions: [{param: '<string>', value: {}}]
}
],
function: {
name: '<string>',
strict: false,
description: '<string>',
parameters: {type: 'object', properties: {}, required: ['<string>']}
},
server: {url: '<string>', timeoutSeconds: 20, secret: '<string>', headers: {}}
}
],
toolIds: ['<string>'],
temperature: 123,
maxTokens: 123,
numFastTurns: 123,
knowledgeBase: {topK: 123, fileIds: ['<string>'], provider: 'canonical'},
fallbackModels: ['standard'],
semanticCachingEnabled: true,
emotionRecognitionEnabled: true
},
voice: {
model: 'standard',
style: 123,
language: '<string>',
chunkPlan: {
enabled: true,
minCharacters: 30,
punctuationBoundaries: ['<string>'],
formatPlan: {
enabled: true,
numberToDigitsCutoff: 2025,
replacements: [{key: '<string>', value: '<string>', type: 'exact'}]
}
},
fillerInjectionEnabled: true,
provider: 'standard',
stability: 123,
similarityBoost: 123,
useSpeakerBoost: false,
enableSsmlParsing: false,
optimizeStreamingLatency: 3
},
hipaaEnabled: false,
clientMessages: ['<string>'],
serverMessages: ['end-of-call-report'],
silenceTimeoutSeconds: 123,
maxDurationSeconds: 123,
backgroundDenoisingEnabled: true,
modelOutputInMessagesEnabled: true,
transportConfigurations: [{provider: 'twilio', timeout: 123, record: true}],
firstMessage: '<string>',
voicemailDetection: {
enabled: true,
provider: '<string>',
machineDetectionTimeout: 123,
voicemailDetectionTypes: ['machine_end_beep', 'machine_end_silence'],
machineDetectionSilenceTimeout: 123,
machineDetectionSpeechThreshold: 123,
machineDetectionSpeechEndThreshold: 123
},
voicemailMessage: '',
endCallMessage: '<string>',
endCallPhrases: ['<string>'],
metadata: {},
serverUrl: '<string>',
serverUrlSecret: '<string>',
analysisPlan: {
successEvaluationRequestTimeoutSeconds: 123,
successEvaluationPrompt: '<string>',
structuredDataSchema: {items: {}, properties: {}, description: '<string>', required: ['<string>']},
structuredDataRequestTimeoutSeconds: 123,
structuredDataPrompt: '<string>',
summaryPrompt: '<string>',
summaryRequestTimeoutSeconds: 123
},
artifactPlan: {
transcriptPlan: {enabled: true, userName: '<string>', assistantName: '<string>'},
recordingEnabled: true,
videoRecordingEnabled: true,
recordingPath: '<string>'
},
messagePlan: {
idleMessages: ['<string>'],
idleMessageMaxSpokenCount: 123,
idleTimeoutSeconds: 123
},
startSpeakingPlan: {
waitSeconds: 123,
smartEndpointingEnabled: true,
transcriptionEndpointingPlan: {onPunctuationSeconds: 123, onNoPunctuationSeconds: 123, onNumberSeconds: 123}
},
stopSpeakingPlan: {numWords: 123, voiceSeconds: 123, backoffSeconds: 123},
monitorPlan: {listenEnabled: true, controlEnabled: true},
transcriber: {
provider: 'standard',
model: 'standard',
language: '<string>',
smartFormat: true,
languageDetectionEnabled: true,
keywords: ['<string>'],
endpointing: 123
},
dialKeypadFunctionEnabled: true,
endCallFunctionEnabled: true,
forwardingPhoneNumber: '<string>'
},
assistantOverrides: {
name: '<string>',
model: {
messages: [{content: '<string>', role: '<string>'}],
provider: 'standard',
model: 'standard',
tools: [
{
type: 'dtmf',
async: false,
messages: [
{
type: 'request-start',
contents: [{type: 'text', text: '<string>'}],
content: '<string>',
conditions: [{param: '<string>', value: {}}]
}
],
function: {
name: '<string>',
strict: false,
description: '<string>',
parameters: {type: 'object', properties: {}, required: ['<string>']}
},
server: {url: '<string>', timeoutSeconds: 20, secret: '<string>', headers: {}}
}
],
toolIds: ['<string>'],
temperature: 123,
maxTokens: 123,
numFastTurns: 123,
knowledgeBase: {topK: 123, fileIds: ['<string>'], provider: 'canonical'},
fallbackModels: ['standard'],
semanticCachingEnabled: true,
emotionRecognitionEnabled: true
},
voice: {
model: 'standard',
style: 123,
language: '<string>',
chunkPlan: {
enabled: true,
minCharacters: 30,
punctuationBoundaries: ['<string>'],
formatPlan: {
enabled: true,
numberToDigitsCutoff: 2025,
replacements: [{key: '<string>', value: '<string>', type: 'exact'}]
}
},
fillerInjectionEnabled: true,
provider: 'standard',
stability: 123,
similarityBoost: 123,
useSpeakerBoost: false,
enableSsmlParsing: false,
optimizeStreamingLatency: 3
},
hipaaEnabled: false,
clientMessages: ['<string>'],
serverMessages: ['end-of-call-report'],
silenceTimeoutSeconds: 123,
maxDurationSeconds: 123,
backgroundDenoisingEnabled: true,
modelOutputInMessagesEnabled: true,
transportConfigurations: [{provider: 'twilio', timeout: 123, record: true}],
firstMessage: '<string>',
voicemailDetection: {
enabled: true,
provider: '<string>',
machineDetectionTimeout: 123,
voicemailDetectionTypes: ['machine_end_beep', 'machine_end_silence'],
machineDetectionSilenceTimeout: 123,
machineDetectionSpeechThreshold: 123,
machineDetectionSpeechEndThreshold: 123
},
voicemailMessage: '',
endCallMessage: '<string>',
endCallPhrases: ['<string>'],
metadata: {},
serverUrl: '<string>',
serverUrlSecret: '<string>',
analysisPlan: {
successEvaluationRequestTimeoutSeconds: 123,
successEvaluationPrompt: '<string>',
structuredDataSchema: {items: {}, properties: {}, description: '<string>', required: ['<string>']},
structuredDataRequestTimeoutSeconds: 123,
structuredDataPrompt: '<string>',
summaryPrompt: '<string>',
summaryRequestTimeoutSeconds: 123
},
artifactPlan: {
transcriptPlan: {enabled: true, userName: '<string>', assistantName: '<string>'},
recordingEnabled: true,
videoRecordingEnabled: true,
recordingPath: '<string>'
},
messagePlan: {
idleMessages: ['<string>'],
idleMessageMaxSpokenCount: 123,
idleTimeoutSeconds: 123
},
startSpeakingPlan: {
waitSeconds: 123,
smartEndpointingEnabled: true,
transcriptionEndpointingPlan: {onPunctuationSeconds: 123, onNoPunctuationSeconds: 123, onNumberSeconds: 123}
},
stopSpeakingPlan: {numWords: 123, voiceSeconds: 123, backoffSeconds: 123},
monitorPlan: {listenEnabled: true, controlEnabled: true},
transcriber: {
provider: 'standard',
model: 'standard',
language: '<string>',
smartFormat: true,
languageDetectionEnabled: true,
keywords: ['<string>'],
endpointing: 123
},
dialKeypadFunctionEnabled: true,
endCallFunctionEnabled: true,
forwardingPhoneNumber: '<string>',
variableValues: {}
},
squadId: '<string>',
squad: {
name: '<string>',
assistants: [
{
name: '<string>',
model: {
messages: [{content: '<string>', role: '<string>'}],
provider: 'standard',
model: 'standard',
tools: [
{
type: 'dtmf',
async: false,
messages: [
{
type: 'request-start',
contents: [{type: 'text', text: '<string>'}],
content: '<string>',
conditions: [{param: '<string>', value: {}}]
}
],
function: {
name: '<string>',
strict: false,
description: '<string>',
parameters: {type: 'object', properties: {}, required: ['<string>']}
},
server: {url: '<string>', timeoutSeconds: 20, secret: '<string>', headers: {}}
}
],
toolIds: ['<string>'],
temperature: 123,
maxTokens: 123,
numFastTurns: 123,
knowledgeBase: {topK: 123, fileIds: ['<string>'], provider: 'canonical'},
fallbackModels: ['standard'],
semanticCachingEnabled: true,
emotionRecognitionEnabled: true
},
voice: {
model: 'standard',
style: 123,
language: '<string>',
chunkPlan: {
enabled: true,
minCharacters: 30,
punctuationBoundaries: ['<string>'],
formatPlan: {
enabled: true,
numberToDigitsCutoff: 2025,
replacements: [{key: '<string>', value: '<string>', type: 'exact'}]
}
},
fillerInjectionEnabled: true,
provider: 'standard',
stability: 123,
similarityBoost: 123,
useSpeakerBoost: false,
enableSsmlParsing: false,
optimizeStreamingLatency: 3
},
hipaaEnabled: false,
clientMessages: ['<string>'],
serverMessages: ['end-of-call-report'],
silenceTimeoutSeconds: 123,
maxDurationSeconds: 123,
backgroundDenoisingEnabled: true,
modelOutputInMessagesEnabled: true,
transportConfigurations: [{provider: 'twilio', timeout: 123, record: true}],
firstMessage: '<string>',
voicemailDetection: {
enabled: true,
provider: '<string>',
machineDetectionTimeout: 123,
voicemailDetectionTypes: ['machine_end_beep', 'machine_end_silence'],
machineDetectionSilenceTimeout: 123,
machineDetectionSpeechThreshold: 123,
machineDetectionSpeechEndThreshold: 123
},
voicemailMessage: '',
endCallMessage: '<string>',
endCallPhrases: ['<string>'],
metadata: {},
serverUrl: '<string>',
serverUrlSecret: '<string>',
analysisPlan: {
successEvaluationRequestTimeoutSeconds: 123,
successEvaluationPrompt: '<string>',
structuredDataSchema: {items: {}, properties: {}, description: '<string>', required: ['<string>']},
structuredDataRequestTimeoutSeconds: 123,
structuredDataPrompt: '<string>',
summaryPrompt: '<string>',
summaryRequestTimeoutSeconds: 123
},
artifactPlan: {
transcriptPlan: {enabled: true, userName: '<string>', assistantName: '<string>'},
recordingEnabled: true,
videoRecordingEnabled: true,
recordingPath: '<string>'
},
messagePlan: {
idleMessages: ['<string>'],
idleMessageMaxSpokenCount: 123,
idleTimeoutSeconds: 123
},
startSpeakingPlan: {
waitSeconds: 123,
smartEndpointingEnabled: true,
transcriptionEndpointingPlan: {onPunctuationSeconds: 123, onNoPunctuationSeconds: 123, onNumberSeconds: 123}
},
stopSpeakingPlan: {numWords: 123, voiceSeconds: 123, backoffSeconds: 123},
monitorPlan: {listenEnabled: true, controlEnabled: true},
transcriber: {
provider: 'standard',
model: 'standard',
language: '<string>',
smartFormat: true,
languageDetectionEnabled: true,
keywords: ['<string>'],
endpointing: 123
},
dialKeypadFunctionEnabled: true,
endCallFunctionEnabled: true,
forwardingPhoneNumber: '<string>'
}
]
},
phoneNumberId: '<string>',
phoneNumber: {
number: '<string>',
twilioAccountSid: '<string>',
twilioAuthToken: '<string>',
provider: 'twilio',
name: '<string>',
assistantId: '<string>',
squadId: '<string>',
fallbackDestination: {
number: '<string>',
type: 'number',
extension: '<string>',
callerId: '<string>',
message: '<string>',
description: '<string>',
numberE164CheckEnabled: true
},
serverUrl: '<string>',
serverUrlSecret: '<string>'
},
customerId: '<string>',
customer: {
extension: '<string>',
number: '<string>',
sipUri: '<string>',
name: '<string>',
numberE164CheckEnabled: true
}
})
};
fetch('https://api.voicebot.studio/api/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voicebot.studio/api/v1/calls"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"assistantId\": \"<string>\",\n \"assistant\": {\n \"name\": \"<string>\",\n \"model\": {\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"tools\": [\n {\n \"type\": \"dtmf\",\n \"async\": false,\n \"messages\": [\n {\n \"type\": \"request-start\",\n \"contents\": [\n {\n \"type\": \"text\",\n \"text\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"conditions\": [\n {\n \"param\": \"<string>\",\n \"value\": {}\n }\n ]\n }\n ],\n \"function\": {\n \"name\": \"<string>\",\n \"strict\": false,\n \"description\": \"<string>\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {},\n \"required\": [\n \"<string>\"\n ]\n }\n },\n \"server\": {\n \"url\": \"<string>\",\n \"timeoutSeconds\": 20,\n \"secret\": \"<string>\",\n \"headers\": {}\n }\n }\n ],\n \"toolIds\": [\n \"<string>\"\n ],\n \"temperature\": 123,\n \"maxTokens\": 123,\n \"numFastTurns\": 123,\n \"knowledgeBase\": {\n \"topK\": 123,\n \"fileIds\": [\n \"<string>\"\n ],\n \"provider\": \"canonical\"\n },\n \"fallbackModels\": [\n \"standard\"\n ],\n \"semanticCachingEnabled\": true,\n \"emotionRecognitionEnabled\": true\n },\n \"voice\": {\n \"model\": \"standard\",\n \"style\": 123,\n \"language\": \"<string>\",\n \"chunkPlan\": {\n \"enabled\": true,\n \"minCharacters\": 30,\n \"punctuationBoundaries\": [\n \"<string>\"\n ],\n \"formatPlan\": {\n \"enabled\": true,\n \"numberToDigitsCutoff\": 2025,\n \"replacements\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"type\": \"exact\"\n }\n ]\n }\n },\n \"fillerInjectionEnabled\": true,\n \"provider\": \"standard\",\n \"stability\": 123,\n \"similarityBoost\": 123,\n \"useSpeakerBoost\": false,\n \"enableSsmlParsing\": false,\n \"optimizeStreamingLatency\": 3\n },\n \"hipaaEnabled\": false,\n \"clientMessages\": [\n \"<string>\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\"\n ],\n \"silenceTimeoutSeconds\": 123,\n \"maxDurationSeconds\": 123,\n \"backgroundDenoisingEnabled\": true,\n \"modelOutputInMessagesEnabled\": true,\n \"transportConfigurations\": [\n {\n \"provider\": \"twilio\",\n \"timeout\": 123,\n \"record\": true\n }\n ],\n \"firstMessage\": \"<string>\",\n \"voicemailDetection\": {\n \"enabled\": true,\n \"provider\": \"<string>\",\n \"machineDetectionTimeout\": 123,\n \"voicemailDetectionTypes\": [\n \"machine_end_beep\",\n \"machine_end_silence\"\n ],\n \"machineDetectionSilenceTimeout\": 123,\n \"machineDetectionSpeechThreshold\": 123,\n \"machineDetectionSpeechEndThreshold\": 123\n },\n \"voicemailMessage\": \"\",\n \"endCallMessage\": \"<string>\",\n \"endCallPhrases\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\",\n \"analysisPlan\": {\n \"successEvaluationRequestTimeoutSeconds\": 123,\n \"successEvaluationPrompt\": \"<string>\",\n \"structuredDataSchema\": {\n \"items\": {},\n \"properties\": {},\n \"description\": \"<string>\",\n \"required\": [\n \"<string>\"\n ]\n },\n \"structuredDataRequestTimeoutSeconds\": 123,\n \"structuredDataPrompt\": \"<string>\",\n \"summaryPrompt\": \"<string>\",\n \"summaryRequestTimeoutSeconds\": 123\n },\n \"artifactPlan\": {\n \"transcriptPlan\": {\n \"enabled\": true,\n \"userName\": \"<string>\",\n \"assistantName\": \"<string>\"\n },\n \"recordingEnabled\": true,\n \"videoRecordingEnabled\": true,\n \"recordingPath\": \"<string>\"\n },\n \"messagePlan\": {\n \"idleMessages\": [\n \"<string>\"\n ],\n \"idleMessageMaxSpokenCount\": 123,\n \"idleTimeoutSeconds\": 123\n },\n \"startSpeakingPlan\": {\n \"waitSeconds\": 123,\n \"smartEndpointingEnabled\": true,\n \"transcriptionEndpointingPlan\": {\n \"onPunctuationSeconds\": 123,\n \"onNoPunctuationSeconds\": 123,\n \"onNumberSeconds\": 123\n }\n },\n \"stopSpeakingPlan\": {\n \"numWords\": 123,\n \"voiceSeconds\": 123,\n \"backoffSeconds\": 123\n },\n \"monitorPlan\": {\n \"listenEnabled\": true,\n \"controlEnabled\": true\n },\n \"transcriber\": {\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"language\": \"<string>\",\n \"smartFormat\": true,\n \"languageDetectionEnabled\": true,\n \"keywords\": [\n \"<string>\"\n ],\n \"endpointing\": 123\n },\n \"dialKeypadFunctionEnabled\": true,\n \"endCallFunctionEnabled\": true,\n \"forwardingPhoneNumber\": \"<string>\"\n },\n \"assistantOverrides\": {\n \"name\": \"<string>\",\n \"model\": {\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"tools\": [\n {\n \"type\": \"dtmf\",\n \"async\": false,\n \"messages\": [\n {\n \"type\": \"request-start\",\n \"contents\": [\n {\n \"type\": \"text\",\n \"text\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"conditions\": [\n {\n \"param\": \"<string>\",\n \"value\": {}\n }\n ]\n }\n ],\n \"function\": {\n \"name\": \"<string>\",\n \"strict\": false,\n \"description\": \"<string>\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {},\n \"required\": [\n \"<string>\"\n ]\n }\n },\n \"server\": {\n \"url\": \"<string>\",\n \"timeoutSeconds\": 20,\n \"secret\": \"<string>\",\n \"headers\": {}\n }\n }\n ],\n \"toolIds\": [\n \"<string>\"\n ],\n \"temperature\": 123,\n \"maxTokens\": 123,\n \"numFastTurns\": 123,\n \"knowledgeBase\": {\n \"topK\": 123,\n \"fileIds\": [\n \"<string>\"\n ],\n \"provider\": \"canonical\"\n },\n \"fallbackModels\": [\n \"standard\"\n ],\n \"semanticCachingEnabled\": true,\n \"emotionRecognitionEnabled\": true\n },\n \"voice\": {\n \"model\": \"standard\",\n \"style\": 123,\n \"language\": \"<string>\",\n \"chunkPlan\": {\n \"enabled\": true,\n \"minCharacters\": 30,\n \"punctuationBoundaries\": [\n \"<string>\"\n ],\n \"formatPlan\": {\n \"enabled\": true,\n \"numberToDigitsCutoff\": 2025,\n \"replacements\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"type\": \"exact\"\n }\n ]\n }\n },\n \"fillerInjectionEnabled\": true,\n \"provider\": \"standard\",\n \"stability\": 123,\n \"similarityBoost\": 123,\n \"useSpeakerBoost\": false,\n \"enableSsmlParsing\": false,\n \"optimizeStreamingLatency\": 3\n },\n \"hipaaEnabled\": false,\n \"clientMessages\": [\n \"<string>\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\"\n ],\n \"silenceTimeoutSeconds\": 123,\n \"maxDurationSeconds\": 123,\n \"backgroundDenoisingEnabled\": true,\n \"modelOutputInMessagesEnabled\": true,\n \"transportConfigurations\": [\n {\n \"provider\": \"twilio\",\n \"timeout\": 123,\n \"record\": true\n }\n ],\n \"firstMessage\": \"<string>\",\n \"voicemailDetection\": {\n \"enabled\": true,\n \"provider\": \"<string>\",\n \"machineDetectionTimeout\": 123,\n \"voicemailDetectionTypes\": [\n \"machine_end_beep\",\n \"machine_end_silence\"\n ],\n \"machineDetectionSilenceTimeout\": 123,\n \"machineDetectionSpeechThreshold\": 123,\n \"machineDetectionSpeechEndThreshold\": 123\n },\n \"voicemailMessage\": \"\",\n \"endCallMessage\": \"<string>\",\n \"endCallPhrases\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\",\n \"analysisPlan\": {\n \"successEvaluationRequestTimeoutSeconds\": 123,\n \"successEvaluationPrompt\": \"<string>\",\n \"structuredDataSchema\": {\n \"items\": {},\n \"properties\": {},\n \"description\": \"<string>\",\n \"required\": [\n \"<string>\"\n ]\n },\n \"structuredDataRequestTimeoutSeconds\": 123,\n \"structuredDataPrompt\": \"<string>\",\n \"summaryPrompt\": \"<string>\",\n \"summaryRequestTimeoutSeconds\": 123\n },\n \"artifactPlan\": {\n \"transcriptPlan\": {\n \"enabled\": true,\n \"userName\": \"<string>\",\n \"assistantName\": \"<string>\"\n },\n \"recordingEnabled\": true,\n \"videoRecordingEnabled\": true,\n \"recordingPath\": \"<string>\"\n },\n \"messagePlan\": {\n \"idleMessages\": [\n \"<string>\"\n ],\n \"idleMessageMaxSpokenCount\": 123,\n \"idleTimeoutSeconds\": 123\n },\n \"startSpeakingPlan\": {\n \"waitSeconds\": 123,\n \"smartEndpointingEnabled\": true,\n \"transcriptionEndpointingPlan\": {\n \"onPunctuationSeconds\": 123,\n \"onNoPunctuationSeconds\": 123,\n \"onNumberSeconds\": 123\n }\n },\n \"stopSpeakingPlan\": {\n \"numWords\": 123,\n \"voiceSeconds\": 123,\n \"backoffSeconds\": 123\n },\n \"monitorPlan\": {\n \"listenEnabled\": true,\n \"controlEnabled\": true\n },\n \"transcriber\": {\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"language\": \"<string>\",\n \"smartFormat\": true,\n \"languageDetectionEnabled\": true,\n \"keywords\": [\n \"<string>\"\n ],\n \"endpointing\": 123\n },\n \"dialKeypadFunctionEnabled\": true,\n \"endCallFunctionEnabled\": true,\n \"forwardingPhoneNumber\": \"<string>\",\n \"variableValues\": {}\n },\n \"squadId\": \"<string>\",\n \"squad\": {\n \"name\": \"<string>\",\n \"assistants\": [\n {\n \"name\": \"<string>\",\n \"model\": {\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"tools\": [\n {\n \"type\": \"dtmf\",\n \"async\": false,\n \"messages\": [\n {\n \"type\": \"request-start\",\n \"contents\": [\n {\n \"type\": \"text\",\n \"text\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"conditions\": [\n {\n \"param\": \"<string>\",\n \"value\": {}\n }\n ]\n }\n ],\n \"function\": {\n \"name\": \"<string>\",\n \"strict\": false,\n \"description\": \"<string>\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {},\n \"required\": [\n \"<string>\"\n ]\n }\n },\n \"server\": {\n \"url\": \"<string>\",\n \"timeoutSeconds\": 20,\n \"secret\": \"<string>\",\n \"headers\": {}\n }\n }\n ],\n \"toolIds\": [\n \"<string>\"\n ],\n \"temperature\": 123,\n \"maxTokens\": 123,\n \"numFastTurns\": 123,\n \"knowledgeBase\": {\n \"topK\": 123,\n \"fileIds\": [\n \"<string>\"\n ],\n \"provider\": \"canonical\"\n },\n \"fallbackModels\": [\n \"standard\"\n ],\n \"semanticCachingEnabled\": true,\n \"emotionRecognitionEnabled\": true\n },\n \"voice\": {\n \"model\": \"standard\",\n \"style\": 123,\n \"language\": \"<string>\",\n \"chunkPlan\": {\n \"enabled\": true,\n \"minCharacters\": 30,\n \"punctuationBoundaries\": [\n \"<string>\"\n ],\n \"formatPlan\": {\n \"enabled\": true,\n \"numberToDigitsCutoff\": 2025,\n \"replacements\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"type\": \"exact\"\n }\n ]\n }\n },\n \"fillerInjectionEnabled\": true,\n \"provider\": \"standard\",\n \"stability\": 123,\n \"similarityBoost\": 123,\n \"useSpeakerBoost\": false,\n \"enableSsmlParsing\": false,\n \"optimizeStreamingLatency\": 3\n },\n \"hipaaEnabled\": false,\n \"clientMessages\": [\n \"<string>\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\"\n ],\n \"silenceTimeoutSeconds\": 123,\n \"maxDurationSeconds\": 123,\n \"backgroundDenoisingEnabled\": true,\n \"modelOutputInMessagesEnabled\": true,\n \"transportConfigurations\": [\n {\n \"provider\": \"twilio\",\n \"timeout\": 123,\n \"record\": true\n }\n ],\n \"firstMessage\": \"<string>\",\n \"voicemailDetection\": {\n \"enabled\": true,\n \"provider\": \"<string>\",\n \"machineDetectionTimeout\": 123,\n \"voicemailDetectionTypes\": [\n \"machine_end_beep\",\n \"machine_end_silence\"\n ],\n \"machineDetectionSilenceTimeout\": 123,\n \"machineDetectionSpeechThreshold\": 123,\n \"machineDetectionSpeechEndThreshold\": 123\n },\n \"voicemailMessage\": \"\",\n \"endCallMessage\": \"<string>\",\n \"endCallPhrases\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\",\n \"analysisPlan\": {\n \"successEvaluationRequestTimeoutSeconds\": 123,\n \"successEvaluationPrompt\": \"<string>\",\n \"structuredDataSchema\": {\n \"items\": {},\n \"properties\": {},\n \"description\": \"<string>\",\n \"required\": [\n \"<string>\"\n ]\n },\n \"structuredDataRequestTimeoutSeconds\": 123,\n \"structuredDataPrompt\": \"<string>\",\n \"summaryPrompt\": \"<string>\",\n \"summaryRequestTimeoutSeconds\": 123\n },\n \"artifactPlan\": {\n \"transcriptPlan\": {\n \"enabled\": true,\n \"userName\": \"<string>\",\n \"assistantName\": \"<string>\"\n },\n \"recordingEnabled\": true,\n \"videoRecordingEnabled\": true,\n \"recordingPath\": \"<string>\"\n },\n \"messagePlan\": {\n \"idleMessages\": [\n \"<string>\"\n ],\n \"idleMessageMaxSpokenCount\": 123,\n \"idleTimeoutSeconds\": 123\n },\n \"startSpeakingPlan\": {\n \"waitSeconds\": 123,\n \"smartEndpointingEnabled\": true,\n \"transcriptionEndpointingPlan\": {\n \"onPunctuationSeconds\": 123,\n \"onNoPunctuationSeconds\": 123,\n \"onNumberSeconds\": 123\n }\n },\n \"stopSpeakingPlan\": {\n \"numWords\": 123,\n \"voiceSeconds\": 123,\n \"backoffSeconds\": 123\n },\n \"monitorPlan\": {\n \"listenEnabled\": true,\n \"controlEnabled\": true\n },\n \"transcriber\": {\n \"provider\": \"standard\",\n \"model\": \"standard\",\n \"language\": \"<string>\",\n \"smartFormat\": true,\n \"languageDetectionEnabled\": true,\n \"keywords\": [\n \"<string>\"\n ],\n \"endpointing\": 123\n },\n \"dialKeypadFunctionEnabled\": true,\n \"endCallFunctionEnabled\": true,\n \"forwardingPhoneNumber\": \"<string>\"\n }\n ]\n },\n \"phoneNumberId\": \"<string>\",\n \"phoneNumber\": {\n \"number\": \"<string>\",\n \"twilioAccountSid\": \"<string>\",\n \"twilioAuthToken\": \"<string>\",\n \"provider\": \"twilio\",\n \"name\": \"<string>\",\n \"assistantId\": \"<string>\",\n \"squadId\": \"<string>\",\n \"fallbackDestination\": {\n \"number\": \"<string>\",\n \"type\": \"number\",\n \"extension\": \"<string>\",\n \"callerId\": \"<string>\",\n \"message\": \"<string>\",\n \"description\": \"<string>\",\n \"numberE164CheckEnabled\": true\n },\n \"serverUrl\": \"<string>\",\n \"serverUrlSecret\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"customer\": {\n \"extension\": \"<string>\",\n \"number\": \"<string>\",\n \"sipUri\": \"<string>\",\n \"name\": \"<string>\",\n \"numberE164CheckEnabled\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "<string>",
"type": "<string>",
"messages": [
{
"secondsFromStart": 123,
"role": "<string>",
"message": "<string>",
"time": 123,
"endTime": 123,
"source": "<string>",
"duration": 123
}
],
"phoneCallProvider": "<string>",
"phoneCallTransport": "<string>",
"status": "<string>",
"endedReason": "<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",
"analysis": {
"summary": "<string>",
"successEvaluation": "<string>"
},
"phoneCallProviderId": "<string>",
"assistantId": "<string>",
"phoneNumberId": "<string>",
"customer": {},
"transcript": "<string>",
"recordingUrl": "<string>",
"summary": "<string>",
"stereoRecordingUrl": "<string>",
"transport": {},
"organizationId": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I