Skip to content

Commit 3ca4302

Browse files
unify-dev-botunify-dev-bot
committed
updated docs
1 parent a1d66b4 commit 3ca4302

6 files changed

Lines changed: 199 additions & 26 deletions

File tree

‎api-reference/assistant_management/create_a_new_assistant.mdx‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ URL to the assistant's profile photo
4444
URL to the assistant's profile video
4545
</ParamField>
4646

47+
<ParamField body="desktop_url" type="string | null" >
48+
URL to the assistant's desktop profile/page
49+
</ParamField>
50+
51+
<ParamField body="user_local_desktop" type="string | null" >
52+
User's local desktop operating system
53+
</ParamField>
54+
4755
<ParamField body="about" type="string | null" >
4856
Brief description about the assistant
4957
</ParamField>
@@ -57,7 +65,11 @@ Email of the assistant
5765
</ParamField>
5866

5967
<ParamField body="voice_id" type="string | null" >
60-
Id of the voice (Cartesia ID) to use for the assistant
68+
Id of the provider voice to use for the assistant
69+
</ParamField>
70+
71+
<ParamField body="voice_provider" type="string | null" default="elevenlabs">
72+
Provider of the selected voice (e.g., 'elevenlabs', 'openai')
6173
</ParamField>
6274

6375
<ParamField body="user_phone" type="string | null" >
@@ -96,10 +108,13 @@ curl --request POST \
96108
"region": "North America",
97109
"profile_photo": "https://example.com/photos/ada.jpg",
98110
"profile_video": "https://example.com/videos/ada.mp4",
111+
"desktop_url": "https://app.example.com/assistants/ada",
112+
"user_local_desktop": "windows",
99113
"about": "Mathematician and writer known for work on Analytical Engine",
100114
"country": "US",
101115
"email": "ada.lovelace@unify.ai",
102116
"voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
117+
"voice_provider": "elevenlabs",
103118
"user_phone": "+15551234567",
104119
"user_whatsapp_number": "+15551234567"
105120
}'
@@ -112,7 +127,7 @@ url = "https://api.unify.ai/v0/assistant"
112127

113128
headers = {"Authorization": "Bearer <token>"}
114129

115-
json_input = {"first_name": "Ada", "surname": "Lovelace", "age": 28, "weekly_limit": 15.75, "max_parallel": 2, "region": "North America", "profile_photo": "https://example.com/photos/ada.jpg", "profile_video": "https://example.com/videos/ada.mp4", "about": "Mathematician and writer known for work on Analytical Engine", "country": "US", "email": "ada.lovelace@unify.ai", "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5", "user_phone": "+15551234567", "user_whatsapp_number": "+15551234567"}
130+
json_input = {"first_name": "Ada", "surname": "Lovelace", "age": 28, "weekly_limit": 15.75, "max_parallel": 2, "region": "North America", "profile_photo": "https://example.com/photos/ada.jpg", "profile_video": "https://example.com/videos/ada.mp4", "desktop_url": "https://app.example.com/assistants/ada", "user_local_desktop": "windows", "about": "Mathematician and writer known for work on Analytical Engine", "country": "US", "email": "ada.lovelace@unify.ai", "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5", "voice_provider": "elevenlabs", "user_phone": "+15551234567", "user_whatsapp_number": "+15551234567"}
116131

117132
response = requests.request("POST", url, json=json_input, headers=headers)
118133

‎api-reference/assistant_management/list_all_assistants.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ print(response.text)
6060
"profile_video": "https://example.com/videos/alice.mp4",
6161
"about": "Mathematician and writer known for work on Analytical Engine",
6262
"voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
63+
"voice_provider": "cartesia",
6364
"country": "US",
6465
"created_at": "2025-04-25T12:00:00Z",
6566
"updated_at": "2025-04-25T12:00:00Z"
@@ -78,6 +79,7 @@ print(response.text)
7879
"profile_video": "https://example.com/videos/bob.mp4",
7980
"about": "Machine learning expert with focus on computer vision",
8081
"voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
82+
"voice_provider": "cartesia",
8183
"country": "CA",
8284
"created_at": "2025-04-24T10:30:00Z",
8385
"updated_at": "2025-04-24T10:30:00Z"

‎api-reference/assistant_management/update_assistant_configuration.mdx‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ URL to the assistant's profile photo
3434
URL to the assistant's profile video
3535
</ParamField>
3636

37+
<ParamField body="desktop_url" type="string | null" >
38+
URL to the assistant's desktop profile/page
39+
</ParamField>
40+
41+
<ParamField body="user_local_desktop" type="string | null" >
42+
User's local desktop operating system
43+
</ParamField>
44+
3745
<ParamField body="about" type="string | null" >
3846
Brief description about the assistant
3947
</ParamField>
@@ -58,6 +66,10 @@ WhatsApp number of the user
5866
Id of the voice (Cartesia ID) to use for the assistant
5967
</ParamField>
6068

69+
<ParamField body="voice_provider" type="string | null" >
70+
Provider of the selected voice (e.g., 'elevenlabs', 'openai')
71+
</ParamField>
72+
6173
<ParamField body="country" type="string | null" >
6274
Country code for phone number provisioning (e.g., US, GB)
6375
</ParamField>
@@ -78,12 +90,15 @@ curl --request PATCH \
7890
"max_parallel": 3,
7991
"profile_photo": "https://example.com/photos/ada.jpg",
8092
"profile_video": "https://example.com/videos/ada_new.mp4",
93+
"desktop_url": "https://app.example.com/assistants/ada",
94+
"user_local_desktop": "macos",
8195
"about": "Award-winning mathematician specializing in algorithm development",
8296
"user_phone": "+15551234567",
8397
"phone": "+15559876543",
8498
"email": "ada.lovelace@newdomain.com",
8599
"user_whatsapp_number": "+15559876543",
86100
"voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
101+
"voice_provider": "elevenlabs",
87102
"country": "GB"
88103
}'
89104
```
@@ -95,7 +110,7 @@ url = "https://api.unify.ai/v0/assistant/<assistant_id>/config"
95110

96111
headers = {"Authorization": "Bearer <token>"}
97112

98-
json_input = {"weekly_limit": 20.5, "max_parallel": 3, "profile_photo": "https://example.com/photos/ada.jpg", "profile_video": "https://example.com/videos/ada_new.mp4", "about": "Award-winning mathematician specializing in algorithm development", "user_phone": "+15551234567", "phone": "+15559876543", "email": "ada.lovelace@newdomain.com", "user_whatsapp_number": "+15559876543", "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5", "country": "GB"}
113+
json_input = {"weekly_limit": 20.5, "max_parallel": 3, "profile_photo": "https://example.com/photos/ada.jpg", "profile_video": "https://example.com/videos/ada_new.mp4", "desktop_url": "https://app.example.com/assistants/ada", "user_local_desktop": "macos", "about": "Award-winning mathematician specializing in algorithm development", "user_phone": "+15551234567", "phone": "+15559876543", "email": "ada.lovelace@newdomain.com", "user_whatsapp_number": "+15559876543", "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5", "voice_provider": "elevenlabs", "country": "GB"}
99114

100115
response = requests.request("PATCH", url, json=json_input, headers=headers)
101116

@@ -121,6 +136,7 @@ print(response.text)
121136
"profile_photo": "https://example.com/photos/alice.jpg",
122137
"profile_video": "https://example.com/videos/alice.mp4",
123138
"voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
139+
"voice_provider": "cartesia",
124140
"country": "US",
125141
"created_at": "2025-04-25T12:00:00Z",
126142
"updated_at": "2025-04-25T14:30:00Z"

‎api-reference/llm_queries/chat_completions.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ curl --request POST \
194194
"response_format": "{ \"type\": \"json_mode\"}",
195195
"seed": 11,
196196
"stream_options": [
197-
true,
198-
"include_usage"
197+
"include_usage",
198+
true
199199
],
200200
"top_p": 0.5,
201201
"tool_choice": "{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}",
@@ -218,7 +218,7 @@ url = "https://api.unify.ai/v0/chat/completions"
218218

219219
headers = {"Authorization": "Bearer <token>"}
220220

221-
json_input = {"messages": [{"content": "Tell me a joke", "role": "user"}], "model": "gpt-4o-mini@openai", "max_tokens": 1024, "stop": ["The End.", " is the answer."], "stream": False, "temperature": 0.9, "frequency_penalty": 1.5, "logit_bias": {"0": 10, "1": -75, "2": 90}, "logprobs": False, "top_logprobs": 15, "n": 15, "presence_penalty": -1.1, "response_format": "{ "type": "json_mode"}", "seed": 11, "stream_options": [True, "include_usage"], "top_p": 0.5, "tool_choice": "{"type": "function", "function": {"name": "my_function"}}", "parallel_tool_calls": True, "user": "some_user", "signature": "python", "use_custom_keys": True, "tags": ["user123", "CompanyABC"], "drop_params": True}
221+
json_input = {"messages": [{"content": "Tell me a joke", "role": "user"}], "model": "gpt-4o-mini@openai", "max_tokens": 1024, "stop": ["The End.", " is the answer."], "stream": False, "temperature": 0.9, "frequency_penalty": 1.5, "logit_bias": {"0": 10, "1": -75, "2": 90}, "logprobs": False, "top_logprobs": 15, "n": 15, "presence_penalty": -1.1, "response_format": "{ "type": "json_mode"}", "seed": 11, "stream_options": ["include_usage", True], "top_p": 0.5, "tool_choice": "{"type": "function", "function": {"name": "my_function"}}", "parallel_tool_calls": True, "user": "some_user", "signature": "python", "use_custom_keys": True, "tags": ["user123", "CompanyABC"], "drop_params": True}
222222

223223
response = requests.request("POST", url, json=json_input, headers=headers)
224224

0 commit comments

Comments
 (0)