Skip to main content
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>",
  "platform": "voiceflow",
  "apiId": "<string>",
  "apiKey": "<string>",
  "platformCredentials": {},
  "agentConfig": {
    "usingExternalWidget": false,
    "useImportWebhook": false,
    "isTemplate": false,
    "isSaas": false
  }
}'
{
  "message": "Agent created successfully"
}

Headers

​
Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Body

application/json
​
name
string
required

The agent's name

​
platform
enum<string>
required

The agent's platform

Available options:
voiceflow,
openai,
botpress,
vectorshift,
flowise,
vapi,
retell,
elevenlabs,
n8n,
custom
​
apiId
string

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
​
apiKey
string

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
​
platformCredentials
object

Additional credentials for interacting with certain agent platform's API (field only required for the specified platforms below)

  • Not Required
  • Botpress
  • Flowise
  • Vapi
  • n8n
​
agentConfig
object

Configuration settings defining how the system will handle the agent

Response

OK

​
message
string
Example:

"Agent created successfully"