Create Agent
curl --request POST \
--url https://api.chat-dash.com/v1/public/agents \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"apiId": "<string>",
"apiKey": "<string>",
"platformCredentials": {},
"agentConfig": {
"usingExternalWidget": false,
"useImportWebhook": false,
"isTemplate": false,
"isSaas": false
}
}
'import requests
url = "https://api.chat-dash.com/v1/public/agents"
payload = {
"name": "<string>",
"apiId": "<string>",
"apiKey": "<string>",
"platformCredentials": {},
"agentConfig": {
"usingExternalWidget": False,
"useImportWebhook": False,
"isTemplate": False,
"isSaas": False
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
apiId: '<string>',
apiKey: '<string>',
platformCredentials: {},
agentConfig: {
usingExternalWidget: false,
useImportWebhook: false,
isTemplate: false,
isSaas: false
}
})
};
fetch('https://api.chat-dash.com/v1/public/agents', 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.chat-dash.com/v1/public/agents",
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>',
'apiId' => '<string>',
'apiKey' => '<string>',
'platformCredentials' => [
],
'agentConfig' => [
'usingExternalWidget' => false,
'useImportWebhook' => false,
'isTemplate' => false,
'isSaas' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.chat-dash.com/v1/public/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"apiId\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"platformCredentials\": {},\n \"agentConfig\": {\n \"usingExternalWidget\": false,\n \"useImportWebhook\": false,\n \"isTemplate\": false,\n \"isSaas\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.chat-dash.com/v1/public/agents")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"apiId\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"platformCredentials\": {},\n \"agentConfig\": {\n \"usingExternalWidget\": false,\n \"useImportWebhook\": false,\n \"isTemplate\": false,\n \"isSaas\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chat-dash.com/v1/public/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"apiId\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"platformCredentials\": {},\n \"agentConfig\": {\n \"usingExternalWidget\": false,\n \"useImportWebhook\": false,\n \"isTemplate\": false,\n \"isSaas\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Agent created successfully"
}{
"error": "An unexpected error occurred"
}Agents
Create Agent
Create a new agent
POST
/
agents
Create Agent
curl --request POST \
--url https://api.chat-dash.com/v1/public/agents \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"apiId": "<string>",
"apiKey": "<string>",
"platformCredentials": {},
"agentConfig": {
"usingExternalWidget": false,
"useImportWebhook": false,
"isTemplate": false,
"isSaas": false
}
}
'import requests
url = "https://api.chat-dash.com/v1/public/agents"
payload = {
"name": "<string>",
"apiId": "<string>",
"apiKey": "<string>",
"platformCredentials": {},
"agentConfig": {
"usingExternalWidget": False,
"useImportWebhook": False,
"isTemplate": False,
"isSaas": False
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
apiId: '<string>',
apiKey: '<string>',
platformCredentials: {},
agentConfig: {
usingExternalWidget: false,
useImportWebhook: false,
isTemplate: false,
isSaas: false
}
})
};
fetch('https://api.chat-dash.com/v1/public/agents', 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.chat-dash.com/v1/public/agents",
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>',
'apiId' => '<string>',
'apiKey' => '<string>',
'platformCredentials' => [
],
'agentConfig' => [
'usingExternalWidget' => false,
'useImportWebhook' => false,
'isTemplate' => false,
'isSaas' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.chat-dash.com/v1/public/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"apiId\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"platformCredentials\": {},\n \"agentConfig\": {\n \"usingExternalWidget\": false,\n \"useImportWebhook\": false,\n \"isTemplate\": false,\n \"isSaas\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.chat-dash.com/v1/public/agents")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"apiId\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"platformCredentials\": {},\n \"agentConfig\": {\n \"usingExternalWidget\": false,\n \"useImportWebhook\": false,\n \"isTemplate\": false,\n \"isSaas\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chat-dash.com/v1/public/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"apiId\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"platformCredentials\": {},\n \"agentConfig\": {\n \"usingExternalWidget\": false,\n \"useImportWebhook\": false,\n \"isTemplate\": false,\n \"isSaas\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Agent created successfully"
}{
"error": "An unexpected error occurred"
}Headers
All requests to the ChatDash API must be validated with the agency API Key found on your agency profile
Body
application/json
The agent's name
The agent's platform
Available options:
voiceflow, openai, botpress, vectorshift, flowise, vapi, retell, elevenlabs, n8n, custom The 'ID' for interacting with the agent platform's API. Varies by platform:
- Voiceflow: Project ID
- OpenAI: Assistant ID
- Botpress: Messaging API webhook URL
- Vectorshift: Agent Name on VectorShift
- Flowise: Chatflow ID
- Vapi: Assistant ID
- Retell: Agent ID
- ElevenLabs: Agent ID
- n8n: N/A
- Custom: N/A
The 'Key' for interacting with the agent platform's API. Varies by platform:
- Voiceflow: Dialog API Key
- OpenAI: API Key
- Botpress: Personal Access Token
- Vectorshift: API Key
- Flowise: API Key
- Vapi: Private API Key
- Retell: API Key
- ElevenLabs: API Key
- n8n: N/A
- Custom: N/A
Additional credentials for interacting with certain agent platform's API (field only required for the specified platforms below)
- Not Required
- Botpress
- Flowise
- Vapi
- n8n
Configuration settings defining how the system will handle the agent
Show child attributes
Show child attributes
Response
OK
Example:
"Agent created successfully"
⌘I
