Skip to main content
GET
/
v2.0
/
flows
/
{flowId}
/
chart
/
nodes
/
aiagents
Get AI Agents Nodes
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/aiagents \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "_id": "<string>",
      "type": "if",
      "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "extension": "@cognigy/basic-nodes",
      "label": "A new Node",
      "analyticsLabel": "Step name",
      "comment": "this is a very important node",
      "commentColor": "#ff8a80",
      "isCollapsed": false,
      "isEntryPoint": false,
      "isDisabled": false,
      "name": "Cognigy AI Agent",
      "image": "https://cognigy.com/ai-agent.png",
      "imageOptimizedFormat": true,
      "knowledgeReferenceId": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
      "description": "I am a virtual assistant that can help you with your questions.",
      "speakingStyle": {
        "completeness": "concise",
        "formality": "formal"
      },
      "voiceConfigs": {
        "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2",
        "ttsLanguage": "zh",
        "ttsVendor": "Elevenlabs",
        "ttsModel": "eleven_multilingual_v2",
        "ttsLabel": "microsoft US",
        "ttsDisableCache": false
      },
      "enableVoiceConfigs": false,
      "enableAutoLanguageDetection": true,
      "safetySettings": {
        "avoidHarmfulContent": true,
        "avoidUngroundedContent": true,
        "avoidCopyrightInfringements": true,
        "preventJailbreakAndManipulation": true
      },
      "contactProfilesOption": "selectedProfileFields",
      "contactProfilesSelected": [
        "name",
        "email"
      ],
      "instructions": "I can help you with your questions, provide information and much more.",
      "createdAt": 1694518620,
      "lastChanged": 1694518620,
      "createdBy": "<string>",
      "lastChangedBy": "<string>",
      "nodeId": "<string>"
    }
  ],
  "total": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
flowId
string
required

The unique identifier for the Flow.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Query Parameters

ā€‹
preferredLocaleId
string

The unique identifier for the Locale for the response.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns AI Agents used in the Flow

ā€‹
items
object[]
ā€‹
total
integer
Example:

2