v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Nodes

Get AI Agents Nodes

Gets all AI Agent Nodes from the Flow with full AI Agent details.

get/v2.0/flows/{flowId}/chart/nodes/aiagents

Path parameters

flowIdstring required

The unique identifier for the Flow.

Query parameters

preferredLocaleIdstring

The unique identifier for the Locale for the response.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Response

Returns AI Agents used in the Flow

totalinteger

Example response

{
  "items": [
    {
      "type": "if",
      "extension": "@cognigy/basic-nodes",
      "label": "A new Node",
      "analyticsLabel": "Step name",
      "comment": "this is a very important node",
      "commentColor": "#ff8a80",
      "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
      },
      "enableAutoLanguageDetection": true,
      "contactProfilesOption": "selectedProfileFields",
      "contactProfilesSelected": [
        "name",
        "email"
      ],
      "instructions": "I can help you with your questions, provide information and much more.",
      "createdAt": 1694518620,
      "lastChanged": 1694518620
    }
  ],
  "total": 2
}