POST
/
v0
/
assistant
curl --request POST \
  --url 'https://api.unify.ai/v0/assistant' \
  --header "Authorization: Bearer $UNIFY_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
}'

{
    "info": {
        "agent_id": "123",
        "first_name": "Alice",
        "surname": "Smith",
        "age": 25,
        "weekly_limit": 40.0,
        "max_parallel": 3,
        "created_at": "2025-04-25T12:00:00Z",
        "updated_at": "2025-04-25T12:00:00Z",
        "phone": "+1-555-123-4567",
        "email": "alice.smith@example.com",
        "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
        "country": "US"
    }
}
Creates a new assistant for the authenticated user with the specified configuration. This action will deduct credits from the user account.

​
Authorizations

​
Authorization
string
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Body

​
first_name
string | null
First name of the assistant
​
surname
string | null
Surname of the assistant
​
age
integer | null
Age of the assistant
​
weekly_limit
number | null
Weekly time limit for the assistant in hours
​
max_parallel
integer | null
Maximum number of parallel tasks the assistant can handle
​
region
string | null
Geographic region of the assistant
​
profile_photo
string | null
URL to the assistant’s profile photo
​
profile_video
string | null
URL to the assistant’s profile video
​
about
string | null
Brief description about the assistant
​
country
string | null
default:"US"
Country code for phone number provisioning (e.g., US, GB)
​
email
string | null
Email of the assistant
​
voice_id
string | null
Id of the voice (Cartesia ID) to use for the assistant
​
user_phone
string | null
Contact phone number of the user
​
user_whatsapp_number
string | null
WhatsApp number of the user
​
create_infra
boolean | null
default:"true"
Whether to create the infrastructure for the assistant
​
phone
string | null
Phone number of the assistant (just for testing purposes)
​
pre_hire_chat
array | null
A list of chat messages from the pre-hire conversation to be logged.
curl --request POST \
  --url 'https://api.unify.ai/v0/assistant' \
  --header "Authorization: Bearer $UNIFY_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
}'

{
    "info": {
        "agent_id": "123",
        "first_name": "Alice",
        "surname": "Smith",
        "age": 25,
        "weekly_limit": 40.0,
        "max_parallel": 3,
        "created_at": "2025-04-25T12:00:00Z",
        "updated_at": "2025-04-25T12:00:00Z",
        "phone": "+1-555-123-4567",
        "email": "alice.smith@example.com",
        "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
        "country": "US"
    }
}