Create Assistant

curl --request POST \
  --url 'https://api.example.com/api/v1/assistant?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

import requests

url = "https://api.example.com/api/v1/assistant?api_key="

payload = {
    "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"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.example.com/api/v1/assistant?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/assistant?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/assistant?api_key="

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"attributes\": {},\n  \"system_prompt\": \"\",\n  \"voice\": false,\n  \"custom_voice\": false,\n  \"voice_languages\": [\n    \"en-US\",\n    \"de-DE\",\n    \"mr-IN\",\n    \"hi-IN\"\n  ],\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"show_images\": false,\n  \"hide_ds\": false,\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"has_human_agent\": false,\n  \"use_tools\": false,\n  \"conversation_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/assistant?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"attributes\": {},\n  \"system_prompt\": \"\",\n  \"voice\": false,\n  \"custom_voice\": false,\n  \"voice_languages\": [\n    \"en-US\",\n    \"de-DE\",\n    \"mr-IN\",\n    \"hi-IN\"\n  ],\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"show_images\": false,\n  \"hide_ds\": false,\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"has_human_agent\": false,\n  \"use_tools\": false,\n  \"conversation_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/assistant?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"attributes\": {},\n  \"system_prompt\": \"\",\n  \"voice\": false,\n  \"custom_voice\": false,\n  \"voice_languages\": [\n    \"en-US\",\n    \"de-DE\",\n    \"mr-IN\",\n    \"hi-IN\"\n  ],\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"show_images\": false,\n  \"hide_ds\": false,\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"has_human_agent\": false,\n  \"use_tools\": false,\n  \"conversation_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

assistant

Create Assistant

curl --request POST \
  --url 'https://api.example.com/api/v1/assistant?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

import requests

url = "https://api.example.com/api/v1/assistant?api_key="

payload = {
    "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"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.example.com/api/v1/assistant?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/assistant?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/assistant?api_key="

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"attributes\": {},\n  \"system_prompt\": \"\",\n  \"voice\": false,\n  \"custom_voice\": false,\n  \"voice_languages\": [\n    \"en-US\",\n    \"de-DE\",\n    \"mr-IN\",\n    \"hi-IN\"\n  ],\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"show_images\": false,\n  \"hide_ds\": false,\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"has_human_agent\": false,\n  \"use_tools\": false,\n  \"conversation_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/assistant?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"attributes\": {},\n  \"system_prompt\": \"\",\n  \"voice\": false,\n  \"custom_voice\": false,\n  \"voice_languages\": [\n    \"en-US\",\n    \"de-DE\",\n    \"mr-IN\",\n    \"hi-IN\"\n  ],\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"show_images\": false,\n  \"hide_ds\": false,\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"has_human_agent\": false,\n  \"use_tools\": false,\n  \"conversation_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/assistant?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"attributes\": {},\n  \"system_prompt\": \"\",\n  \"voice\": false,\n  \"custom_voice\": false,\n  \"voice_languages\": [\n    \"en-US\",\n    \"de-DE\",\n    \"mr-IN\",\n    \"hi-IN\"\n  ],\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"show_images\": false,\n  \"hide_ds\": false,\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"has_human_agent\": false,\n  \"use_tools\": false,\n  \"conversation_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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