Build an assistant from a brief
curl --request POST \
--url https://api.upliftai.org/v1/realtime-assistants/builds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"brief": {
"goal": "appointment",
"voiceId": "v_meklc281",
"gender": "female",
"context": "Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.",
"sampleRows": [
{
"name": "عائشہ صدیقی",
"phone": "+923001234567",
"doctor": "ڈاکٹر عمران شیخ",
"appointmentTime": "کل صبح 11 بجے"
}
]
}
}
EOFimport requests
url = "https://api.upliftai.org/v1/realtime-assistants/builds"
payload = { "brief": {
"goal": "appointment",
"voiceId": "v_meklc281",
"gender": "female",
"context": "Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.",
"sampleRows": [
{
"name": "عائشہ صدیقی",
"phone": "+923001234567",
"doctor": "ڈاکٹر عمران شیخ",
"appointmentTime": "کل صبح 11 بجے"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brief: {
goal: 'appointment',
voiceId: 'v_meklc281',
gender: 'female',
context: 'Shifa Clinic, Lahore. Call patients to confirm tomorrow\'s doctor appointment, remind them of the time, and offer to reschedule if they cannot come.',
sampleRows: [
{
name: 'عائشہ صدیقی',
phone: '+923001234567',
doctor: 'ڈاکٹر عمران شیخ',
appointmentTime: 'کل صبح 11 بجے'
}
]
}
})
};
fetch('https://api.upliftai.org/v1/realtime-assistants/builds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upliftai.org/v1/realtime-assistants/builds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'brief' => [
'goal' => 'appointment',
'voiceId' => 'v_meklc281',
'gender' => 'female',
'context' => 'Shifa Clinic, Lahore. Call patients to confirm tomorrow\'s doctor appointment, remind them of the time, and offer to reschedule if they cannot come.',
'sampleRows' => [
[
'name' => 'عائشہ صدیقی',
'phone' => '+923001234567',
'doctor' => 'ڈاکٹر عمران شیخ',
'appointmentTime' => 'کل صبح 11 بجے'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upliftai.org/v1/realtime-assistants/builds"
payload := strings.NewReader("{\n \"brief\": {\n \"goal\": \"appointment\",\n \"voiceId\": \"v_meklc281\",\n \"gender\": \"female\",\n \"context\": \"Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.\",\n \"sampleRows\": [\n {\n \"name\": \"عائشہ صدیقی\",\n \"phone\": \"+923001234567\",\n \"doctor\": \"ڈاکٹر عمران شیخ\",\n \"appointmentTime\": \"کل صبح 11 بجے\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://api.upliftai.org/v1/realtime-assistants/builds")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brief\": {\n \"goal\": \"appointment\",\n \"voiceId\": \"v_meklc281\",\n \"gender\": \"female\",\n \"context\": \"Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.\",\n \"sampleRows\": [\n {\n \"name\": \"عائشہ صدیقی\",\n \"phone\": \"+923001234567\",\n \"doctor\": \"ڈاکٹر عمران شیخ\",\n \"appointmentTime\": \"کل صبح 11 بجے\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upliftai.org/v1/realtime-assistants/builds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brief\": {\n \"goal\": \"appointment\",\n \"voiceId\": \"v_meklc281\",\n \"gender\": \"female\",\n \"context\": \"Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.\",\n \"sampleRows\": [\n {\n \"name\": \"عائشہ صدیقی\",\n \"phone\": \"+923001234567\",\n \"doctor\": \"ڈاکٹر عمران شیخ\",\n \"appointmentTime\": \"کل صبح 11 بجے\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"buildId": "01407eda-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"assistantId": "9d1d042f-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "started"
}{
"message": [
"brief.goal must be one of the following values: appointment, event, lead, order_confirmation, payment_reminder, outreach, reservation_confirmation",
"brief.voiceId must be a string"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "invalid authorization",
"error": "Unauthorized",
"statusCode": 401
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}Authoring an assistant
Build an assistant from a brief
The assistant exists the moment this returns, but a background pipeline writes and hardens its Urdu prompt over the next few minutes — until the status poll reads done, its entire prompt is the literal text (building…), so don’t put it on a call yet. Poll the build status for the outcome. Every request builds a fresh assistant; to change one you already built, refine it or update its config directly.
POST
/
realtime-assistants
/
builds
Build an assistant from a brief
curl --request POST \
--url https://api.upliftai.org/v1/realtime-assistants/builds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"brief": {
"goal": "appointment",
"voiceId": "v_meklc281",
"gender": "female",
"context": "Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.",
"sampleRows": [
{
"name": "عائشہ صدیقی",
"phone": "+923001234567",
"doctor": "ڈاکٹر عمران شیخ",
"appointmentTime": "کل صبح 11 بجے"
}
]
}
}
EOFimport requests
url = "https://api.upliftai.org/v1/realtime-assistants/builds"
payload = { "brief": {
"goal": "appointment",
"voiceId": "v_meklc281",
"gender": "female",
"context": "Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.",
"sampleRows": [
{
"name": "عائشہ صدیقی",
"phone": "+923001234567",
"doctor": "ڈاکٹر عمران شیخ",
"appointmentTime": "کل صبح 11 بجے"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brief: {
goal: 'appointment',
voiceId: 'v_meklc281',
gender: 'female',
context: 'Shifa Clinic, Lahore. Call patients to confirm tomorrow\'s doctor appointment, remind them of the time, and offer to reschedule if they cannot come.',
sampleRows: [
{
name: 'عائشہ صدیقی',
phone: '+923001234567',
doctor: 'ڈاکٹر عمران شیخ',
appointmentTime: 'کل صبح 11 بجے'
}
]
}
})
};
fetch('https://api.upliftai.org/v1/realtime-assistants/builds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upliftai.org/v1/realtime-assistants/builds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'brief' => [
'goal' => 'appointment',
'voiceId' => 'v_meklc281',
'gender' => 'female',
'context' => 'Shifa Clinic, Lahore. Call patients to confirm tomorrow\'s doctor appointment, remind them of the time, and offer to reschedule if they cannot come.',
'sampleRows' => [
[
'name' => 'عائشہ صدیقی',
'phone' => '+923001234567',
'doctor' => 'ڈاکٹر عمران شیخ',
'appointmentTime' => 'کل صبح 11 بجے'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upliftai.org/v1/realtime-assistants/builds"
payload := strings.NewReader("{\n \"brief\": {\n \"goal\": \"appointment\",\n \"voiceId\": \"v_meklc281\",\n \"gender\": \"female\",\n \"context\": \"Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.\",\n \"sampleRows\": [\n {\n \"name\": \"عائشہ صدیقی\",\n \"phone\": \"+923001234567\",\n \"doctor\": \"ڈاکٹر عمران شیخ\",\n \"appointmentTime\": \"کل صبح 11 بجے\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://api.upliftai.org/v1/realtime-assistants/builds")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brief\": {\n \"goal\": \"appointment\",\n \"voiceId\": \"v_meklc281\",\n \"gender\": \"female\",\n \"context\": \"Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.\",\n \"sampleRows\": [\n {\n \"name\": \"عائشہ صدیقی\",\n \"phone\": \"+923001234567\",\n \"doctor\": \"ڈاکٹر عمران شیخ\",\n \"appointmentTime\": \"کل صبح 11 بجے\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upliftai.org/v1/realtime-assistants/builds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brief\": {\n \"goal\": \"appointment\",\n \"voiceId\": \"v_meklc281\",\n \"gender\": \"female\",\n \"context\": \"Shifa Clinic, Lahore. Call patients to confirm tomorrow's doctor appointment, remind them of the time, and offer to reschedule if they cannot come.\",\n \"sampleRows\": [\n {\n \"name\": \"عائشہ صدیقی\",\n \"phone\": \"+923001234567\",\n \"doctor\": \"ڈاکٹر عمران شیخ\",\n \"appointmentTime\": \"کل صبح 11 بجے\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"buildId": "01407eda-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"assistantId": "9d1d042f-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "started"
}{
"message": [
"brief.goal must be one of the following values: appointment, event, lead, order_confirmation, payment_reminder, outreach, reservation_confirmation",
"brief.voiceId must be a string"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "invalid authorization",
"error": "Unauthorized",
"statusCode": 401
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}Authorizations
Project API key (sk_api_…).
Body
application/json
Show child attributes
Show child attributes
