Update Assistant By Id

Update an Assistant

PUT /api/v1/assistant/{assistant_id}

Update Assistant By Id

cURL

curl --request PUT \
  --url 'https://api.example.com/api/v1/assistant/{assistant_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "attributes": {},
  "system_prompt": "<string>",
  "voice": true,
  "custom_voice": true,
  "voice_languages": [
    "<unknown>"
  ],
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "show_images": true,
  "hide_ds": true,
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "has_human_agent": true,
  "use_tools": true,
  "conversation_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

200

{
  "message": "Data updated successfully",
  "meta": {},
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "attributes": {},
    "system_prompt": "",
    "voice": false,
    "custom_voice": false,
    "voice_languages": [
      "en-US",
      "de-DE",
      "mr-IN",
      "hi-IN"
    ],
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "show_images": false,
    "hide_ds": false,
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "has_human_agent": false,
    "use_tools": false,
    "conversation_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Your API KeyHTTPBearer

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

assistant_id · string<uuid> · required

The UUID id of the assistant

Body

application/json

assistant_type · enum<string> | null

Available options: simple, chat, phone, nl2sql, realtime_openai

llm_model · enum<string> | null

Available options: gpt-4-0125-preview, gpt-3.5-turbo-0125, gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4-1106-preview, gpt-4o-2024-05-13, gpt-4o-mini, llama-3.1-70b-versatile, gpt-4o-realtime-preview, gpt-4o-mini-realtime-preview, deepseek-r1-distill-llama-70b, o3-mini

name · string | null

description · string | null

attributes · Attributes · object

system_prompt · string | null

voice · boolean | null

custom_voice · boolean | null

voice_languages · any[] | null

org_id · string<uuid> | null

show_images · boolean | null

hide_ds · boolean | null

webhook_id · string<uuid> | null

has_human_agent · boolean | null

use_tools · boolean | null

conversation_flow_id · string<uuid> | null

Response

200

application/json

Successful Response

message · string | null · default: Data updated successfully

meta · Meta · object

data · IAssistantRead · object

Show child attributes