Sign in

v1

latestOpenAPI 3.1.02026-07-13154170539.0 KB
Assistant Management

Update assistant configuration

Updates the configuration parameters of an existing assistant. Profile photo cannot be updated via this endpoint.

patch/v0/assistant/{assistant_id}/config

Path parameters

assistant_idinteger required

Request body

first_namestring nullable

First name of the assistant

surnamestring nullable

Surname of the assistant

ageinteger nullable

Age of the assistant

nationalitystring nullable

Assistant's nationality

weekly_limitnumber nullable

Weekly time limit for the assistant in hours

max_parallelinteger nullable

Maximum number of parallel tasks the assistant can handle

profile_photostring nullable

URL to the assistant's profile photo

profile_videostring nullable

URL to the assistant's profile video

desktop_mode'ubuntu' | 'windows' | 'macos' nullable

Desktop operating system mode for VM type

user_desktop_idinteger nullable

ID of the registered user desktop to assign to this assistant

user_desktop_filesys_syncboolean nullable

Whether to enable filesystem sync with user's desktop

aboutstring nullable

Brief description about the assistant

user_phonestring nullable

DEPRECATED – use POST /assistant/{id}/contact instead.

phonestring nullable

DEPRECATED – use POST /assistant/{id}/contact instead.

phone_countrystring nullable

DEPRECATED – use POST /assistant/{id}/contact instead.

emailstring nullable

DEPRECATED – use POST /assistant/{id}/contact instead.

user_whatsapp_numberstring nullable

DEPRECATED – use POST /assistant/{id}/contact instead.

voice_idstring nullable

Id of the voice (Cartesia ID) to use for the assistant

voice_providerstring nullable

Provider of the selected voice (e.g., 'elevenlabs', 'openai')

timezonestring nullable

Timezone of the assistant in IANA format

create_infraboolean nullable

Whether to create infrastructure for the assistant during update (e.g., phone, email). Set to false for testing.

is_localboolean nullable

Whether this is a local assistant (runs unity locally instead of on GKE).

monthly_spending_capnumber nullable

Monthly spending limit in dollars. Set to null to remove the limit.

deploy_env'preview' nullable

Set to 'preview' to route this assistant to the preview runtime stack. Set to null to revert to native routing.

Example request

{
  "first_name": "Ada",
  "surname": "Lovelace",
  "age": 28,
  "nationality": "North America",
  "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_mode": "macos",
  "user_desktop_id": 1,
  "about": "Award-winning mathematician specializing in algorithm development",
  "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
  "voice_provider": "elevenlabs",
  "timezone": "Europe/London",
  "monthly_spending_cap": 100,
  "deploy_env": "preview"
}

Response

Assistant configuration updated successfully

Example response

{
  "info": {
    "first_name": "Ada",
    "surname": "Lovelace",
    "age": 28,
    "weekly_limit": 15.75,
    "max_parallel": 2,
    "nationality": "North America",
    "profile_photo": "https://example.com/photos/ada.jpg",
    "profile_video": "https://example.com/videos/ada.mp4",
    "desktop_mode": "windows",
    "user_desktop_id": 1,
    "about": "Mathematician and writer known for work on Analytical Engine",
    "voice_id": "bf0a246a-8642-498a-9950-80c35e9276b5",
    "voice_provider": "elevenlabs",
    "pre_hire_chat": [
      {
        "role": "assistant",
        "msg": "Hello, how can I help you?"
      }
    ],
    "timezone": "America/New_York",
    "user_desktop_url": "https://abc123.tunnel.unify.ai",
    "user_desktop_mode": "macos",
    "agent_id": "12345",
    "user_id": "123",
    "created_at": "2025-04-25T10:30:00Z",
    "updated_at": "2025-04-26T14:15:00Z",
    "phone": "+15551234567",
    "phone_country": "US",
    "email": "ada.lovelace@unify.ai",
    "user_phone": "+15559876543",
    "user_whatsapp_number": "+15559876543",
    "assistant_whatsapp_number": "+15551234567",
    "api_key": "1234567890",
    "user_first_name": "Ada",
    "user_last_name": "Lovelace",
    "user_email": "ada.lovelace@unify.ai",
    "monthly_spending_cap": 100
  }
}