Fetch Agents
curl --request GET \
--url https://api.chat-dash.com/v1/public/agents \
--header 'Authorization: <authorization>'import requests
url = "https://api.chat-dash.com/v1/public/agents"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.chat-dash.com/v1/public/agents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.chat-dash.com/v1/public/agents")
.header("Authorization", "<authorization>")
.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::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body[
{
"_id": "<string>",
"clientId": "<string>",
"name": "<string>",
"platform": "voiceflow",
"apiId": "<string>",
"apiKey": "<string>",
"platformCredentials": {
"botId": "<string>",
"workspaceId": "<string>"
},
"agentConfig": {
"usingExternalWidget": true,
"useImportWebhook": true,
"isTemplate": true,
"isSaas": true
}
}
]This response has no body data.Agents
Fetch Agents
Fetch all agents in your agency
GET
/
agents
Fetch Agents
curl --request GET \
--url https://api.chat-dash.com/v1/public/agents \
--header 'Authorization: <authorization>'import requests
url = "https://api.chat-dash.com/v1/public/agents"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.chat-dash.com/v1/public/agents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.chat-dash.com/v1/public/agents")
.header("Authorization", "<authorization>")
.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::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body[
{
"_id": "<string>",
"clientId": "<string>",
"name": "<string>",
"platform": "voiceflow",
"apiId": "<string>",
"apiKey": "<string>",
"platformCredentials": {
"botId": "<string>",
"workspaceId": "<string>"
},
"agentConfig": {
"usingExternalWidget": true,
"useImportWebhook": true,
"isTemplate": true,
"isSaas": true
}
}
]This response has no body data.Headers
All requests to the ChatDash API must be validated with the agency API Key found on your agency profile
Response
OK
The ID of the agent
The ID of the client the agent is assigned to
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
- Botpress
- Flowise
- Vapi
- n8n
Show child attributes
Show child attributes
Configuration settings defining how the system will handle the agent
Show child attributes
Show child attributes
