Skip to main content
PATCH
/
assistants
/
{id}
Update Assistant
curl --request PATCH \
  --url https://api.callhq.ai/api/assistants/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Updated Assistant",
  "status": true,
  "description": "This assistant handles hospitality queries.",
  "voice": {
    "provider": "CallHQ",
    "voiceId": "Neha",
    "speed": 1
  },
  "model": {
    "provider": "google",
    "model": "gemini-1.5-pro",
    "temperature": 0.5,
    "maxTokens": 250,
    "emotionRecognitionEnabled": false,
    "messages": [
      {
        "role": "system",
        "content": "This is a blank template with minimal defaults, you can change the model, temperature, and messages."
      }
    ]
  },
  "firstMessage": "Hi! How can I help you today?",
  "firstMessageMode": "assistant-speaks-first",
  "backgroundSound": "office",
  "silenceTimeoutSeconds": 10,
  "backgroundDenoisingEnabled": true,
  "firstMessageInterruptionsEnabled": false,
  "maxDurationSeconds": 3600
}'

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Assistant ID

Body

application/json

Fields to update. Only name, status, and description will be updated locally.

​
name
string
Example:

"Updated Assistant"

​
status
boolean
Example:

true

​
description
string
Example:

"This assistant handles hospitality queries."

​
voice
object
​
model
object
​
firstMessage
string
Example:

"Hi! How can I help you today?"

​
firstMessageMode
enum<string>
Available options:
assistant-speaks-first,
user-speaks-first
Example:

"assistant-speaks-first"

​
backgroundSound
string
Example:

"office"

​
silenceTimeoutSeconds
integer
Example:

10

​
backgroundDenoisingEnabled
boolean
Example:

true

​
firstMessageInterruptionsEnabled
boolean
Example:

false

​
maxDurationSeconds
integer
Example:

3600

Response

Assistant updated successfully