Authorizations
Path Parameters
Response
Successful Response
This is the analysis plan for the assistant.
Server URL must match either workflow.amira.bot or workflow.voicebot.studio
curl --request GET \
--url https://api.voicebot.studio/api/v1/assistants/{assistant_id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"async": false,
"messages": [
{
"contents": "<any>",
"type": "request-start",
"content": "<any>",
"conditions": "<any>"
}
],
"type": "dtmf",
"function": {
"strict": true,
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "<any>",
"properties": "<any>",
"required": "<any>"
}
},
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"provider": "canonical",
"topK": 123,
"fileIds": [
"<string>"
]
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"fillerInjectionEnabled": true,
"model": "standard",
"style": 123,
"voiceId": "Robert",
"language": "<string>",
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": true,
"enableSsmlParsing": true,
"optimizeStreamingLatency": 123,
"chunkPlan": {
"enabled": true,
"minCharacters": 40.5,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 1,
"replacements": [
{
"type": "exact",
"key": "<string>",
"value": "<string>"
}
]
}
}
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"analysisPlan": {
"successEvaluationRubric": "NumericScale",
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"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
},
"clientMessages": [
"<string>"
],
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>",
"organizationId": "<string>",
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Get assistant by ID.
curl --request GET \
--url https://api.voicebot.studio/api/v1/assistants/{assistant_id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"name": "<string>",
"model": {
"messages": [
{
"content": "<string>",
"role": "<string>"
}
],
"provider": "standard",
"model": "standard",
"tools": [
{
"async": false,
"messages": [
{
"contents": "<any>",
"type": "request-start",
"content": "<any>",
"conditions": "<any>"
}
],
"type": "dtmf",
"function": {
"strict": true,
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "<any>",
"properties": "<any>",
"required": "<any>"
}
},
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"secret": "<string>",
"headers": {}
}
}
],
"toolIds": [
"<string>"
],
"temperature": 123,
"maxTokens": 123,
"numFastTurns": 123,
"knowledgeBase": {
"provider": "canonical",
"topK": 123,
"fileIds": [
"<string>"
]
},
"fallbackModels": [
"standard"
],
"semanticCachingEnabled": true,
"emotionRecognitionEnabled": true
},
"voice": {
"fillerInjectionEnabled": true,
"model": "standard",
"style": 123,
"voiceId": "Robert",
"language": "<string>",
"provider": "standard",
"stability": 123,
"similarityBoost": 123,
"useSpeakerBoost": true,
"enableSsmlParsing": true,
"optimizeStreamingLatency": 123,
"chunkPlan": {
"enabled": true,
"minCharacters": 40.5,
"punctuationBoundaries": [
"<string>"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 1,
"replacements": [
{
"type": "exact",
"key": "<string>",
"value": "<string>"
}
]
}
}
},
"transcriber": {
"provider": "standard",
"model": "standard",
"language": "<string>",
"smartFormat": true,
"languageDetectionEnabled": true,
"keywords": [
"<string>"
],
"endpointing": 123
},
"analysisPlan": {
"successEvaluationRubric": "NumericScale",
"successEvaluationRequestTimeoutSeconds": 123,
"successEvaluationPrompt": "<string>",
"structuredDataSchema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"required": [
"<string>"
]
},
"structuredDataRequestTimeoutSeconds": 123,
"structuredDataPrompt": "<string>",
"summaryPrompt": "<string>",
"summaryRequestTimeoutSeconds": 123
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"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
},
"clientMessages": [
"<string>"
],
"dialKeypadFunctionEnabled": true,
"endCallFunctionEnabled": true,
"forwardingPhoneNumber": "<string>",
"organizationId": "<string>",
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Successful Response
Show child attributes
Show child attributes
Show child attributes
This is the analysis plan for the assistant.
Show child attributes
Server URL must match either workflow.amira.bot or workflow.voicebot.studio
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes