Skip to main content
POST
/
api
/
v1
/
assistant
Create Assistant
curl --request POST \
  --url 'https://api.example.com/api/v1/assistant?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_type": "simple",
  "llm_model": "gpt-4-0125-preview",
  "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"
}
'
{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "assistant_type": "simple",
    "llm_model": "gpt-4-0125-preview",
    "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

​
api_key
string
query
required

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

Body

application/json
​
assistant_type
enum<string> | null
required
Available options:
simple,
chat,
phone,
nl2sql,
realtime_openai
​
llm_model
enum<string> | null
required
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
default:""
​
voice
boolean | null
default:false
​
custom_voice
boolean | null
default:false
​
voice_languages
any[]
​
org_id
string<uuid> | null
​
show_images
boolean | null
default:false
​
hide_ds
boolean | null
default:false
​
webhook_id
string<uuid> | null
​
has_human_agent
boolean | null
default:false
​
use_tools
boolean | null
default:false
​
conversation_flow_id
string<uuid> | null

Response

Successful Response

​
message
string | null
default:Data created successfully
​
meta
Meta · object
​
data
IAssistantRead · object