GET
/
agents
/
{agentId}
Fetch Agent
curl --request GET \
  --url https://api.chat-dash.com/v1/public/agents/{agentId} \
  --header 'Authorization: <authorization>'
{
  "_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
  }
}

Headers

​
Authorization
string
required

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

Path Parameters

​
agentId
string
required

The ID of the agent

Response

OK

​
_id
string

The ID of the agent

​
clientId
string

The ID of the client the agent is assigned to

​
name
string

The agent's name

​
platform
enum<string>

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

​
agentConfig
object

Configuration settings defining how the system will handle the agent