curl --request GET \
--url https://api.puretalk.ai/api/ai-assistants/{assistant_id} \
--header 'X-API-KEY: <api-key>'{
"msg": "AI Assistant created successfully",
"err": false,
"results": {
"user": {
"name": "<string>",
"dp": "<string>",
"email": "[email protected]"
},
"voice": {
"voice_id": "<string>",
"name": "<string>",
"avatar": "<string>",
"gender": "<string>",
"demo_audio_url": "<string>",
"is_cloned": true,
"language": "<string>",
"description": "<string>"
},
"llm_states": [
"<unknown>"
],
"phone_number": "<string>",
"variables": [
"<unknown>"
],
"knowledge_base": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": "<string>",
"model": "<string>",
"who_speaks_first": "assistant",
"begin_message": "<string>",
"assistant_type": "<string>",
"avatar": "<string>",
"custom_knowledge_base": "<string>",
"timezone": "<string>",
"voice_stability": 0.5,
"voice_clarity_similarity": 0.5,
"voice_stream_latency_optimization": 2,
"voice_boost": true,
"voice_speed": 123,
"voice_emotion": [
"<unknown>"
],
"call_recording_enabled": true,
"reminder_message_frequency": 123,
"max_reminder_messages": 123,
"post_analysis": "<string>",
"chatbot_logo": "<string>",
"chatbot_accent_color": "<string>",
"chatbot_faq": "<string>",
"chatbot_whitelisted_domains": [
"<string>"
],
"chatbot_begin_message": "<string>",
"tools": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"behavior": 123
}
}Returns a single AI Assistant based on the ID supplied
curl --request GET \
--url https://api.puretalk.ai/api/ai-assistants/{assistant_id} \
--header 'X-API-KEY: <api-key>'{
"msg": "AI Assistant created successfully",
"err": false,
"results": {
"user": {
"name": "<string>",
"dp": "<string>",
"email": "[email protected]"
},
"voice": {
"voice_id": "<string>",
"name": "<string>",
"avatar": "<string>",
"gender": "<string>",
"demo_audio_url": "<string>",
"is_cloned": true,
"language": "<string>",
"description": "<string>"
},
"llm_states": [
"<unknown>"
],
"phone_number": "<string>",
"variables": [
"<unknown>"
],
"knowledge_base": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": "<string>",
"model": "<string>",
"who_speaks_first": "assistant",
"begin_message": "<string>",
"assistant_type": "<string>",
"avatar": "<string>",
"custom_knowledge_base": "<string>",
"timezone": "<string>",
"voice_stability": 0.5,
"voice_clarity_similarity": 0.5,
"voice_stream_latency_optimization": 2,
"voice_boost": true,
"voice_speed": 123,
"voice_emotion": [
"<unknown>"
],
"call_recording_enabled": true,
"reminder_message_frequency": 123,
"max_reminder_messages": 123,
"post_analysis": "<string>",
"chatbot_logo": "<string>",
"chatbot_accent_color": "<string>",
"chatbot_faq": "<string>",
"chatbot_whitelisted_domains": [
"<string>"
],
"chatbot_begin_message": "<string>",
"tools": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"behavior": 123
}
}Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.
ID of AI Assistant to return
AI Assistant response
A success message
"AI Assistant created successfully"
If the request is an error
false
The AI Assistant
Show child attributes
Show child attributes
The voice id of the user
The name of the voice
The avatar of the voice
The gender of the voice
The demo audio url of the voice
Indicates if the voice is cloned
The language of the voice
The description of the voice
The phone number of the AI Assistant
The knowledge base of the AI Assistant
The assistant id of the AI Assistant
The name of the AI Assistant
The prompt of the AI Assistant
The model of the AI Assistant
Who speaks first value of the AI Assistant
assistant, user The begin message of the AI Assistant
The assistant type of the AI Assistant
The avatar of the AI Assistant
The custom knowledge base of the AI Assistant
The timezone of the AI Assistant
The voice stability of the AI Assistant
0 <= x <= 1The voice clarity similarity of the AI Assistant
0 <= x <= 1The voice stream latency optimization of the AI Assistant
0 <= x <= 5Indicates if voice boost is enabled for the AI Assistant
The voice speed of the AI Assistant
Indicates if call recording is enabled for the AI Assistant
The reminder message frequency of the AI Assistant
The maximum reminder messages of the AI Assistant
The post analysis of the AI Assistant
The chatbot logo of the AI Assistant
The chatbot accent color of the AI Assistant
The chatbot FAQ of the AI Assistant
The chatbot begin message of the AI Assistant
The tools of the AI Assistant
The created at date of the AI Assistant
The updated at date of the AI Assistant
The behavior of the AI Assistant
Was this page helpful?