Get AI Agents used in the specified Flow

GET

v2.0

flows

{flowId}

chart

nodes

aiagents

Get AI Agents used in the specified Flow

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/aiagents?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --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,
      "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
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

api_key

string

query

required

Supply the API Key in the Url-Query

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

flowId

string

required

The Id of the Flow

Required string length: 24

Query Parameters

preferredLocaleId

string

Required string length: 24

Response

Returns AI Agents used in the Flow

items

object[]

Show child attributes

items._id

string

Required string length: 24

items.type

string

Example:

"if"

items.referenceId

string<uuid>

items.extension

string

Example:

"@cognigy/basic-nodes"

items.label

string

Example:

"A new Node"

items.analyticsLabel

string

Example:

"Step name"

items.comment

string

Example:

"this is a very important node"

items.commentColor

Example:

"#ff8a80"

items.isCollapsed

boolean

Example:

false

items.isEntryPoint

boolean

Example:

false

items.isDisabled

boolean

Example:

false

items.name

string

Example:

"Cognigy AI Agent"

items.image

string

Avatar of the AI Agent.

Example:

"https://cognigy.com/ai-agent.png"

items.imageOptimizedFormat

boolean

Whether the optimized image format defined by Cognigy is used.

Example:

true

items.knowledgeReferenceId

string<uuid> | null

A referenceId of a Knowledge Store this Agent will use as base knowledge or null.

Example:

"c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"

items.description

string

A short description of the AI Agent, up to 1000 characters.

Maximum string length: 1000

Example:

"I am a virtual assistant that can help you with your questions."

items.speakingStyle

object

Show child attributes

items.speakingStyle.completeness

string

items.speakingStyle.formality

string

Example:

{
  "completeness": "concise",
  "formality": "formal"
}

items.voiceConfigs

object

Show child attributes

items.voiceConfigs.ttsVoice

string

items.voiceConfigs.ttsLanguage

string

items.voiceConfigs.ttsVendor

enum<string>

Available options:

aws,

deepgram,

elevenlabs,

google,

microsoft,

nuance,

default,

custom,

none

items.voiceConfigs.ttsModel

string

items.voiceConfigs.ttsLabel

string

items.voiceConfigs.ttsDisableCache

boolean

Example:

{
  "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2",
  "ttsLanguage": "zh",
  "ttsVendor": "Elevenlabs",
  "ttsModel": "eleven_multilingual_v2",
  "ttsLabel": "microsoft US",
  "ttsDisableCache": false
}

items.enableVoiceConfigs

boolean

Enables the use of voice configuration.

Example:

false

items.safetySettings

object

Show child attributes

items.safetySettings.avoidHarmfulContent

boolean

items.safetySettings.avoidUngroundedContent

boolean

items.safetySettings.avoidCopyrightInfringements

boolean

items.safetySettings.preventJailbreakAndManipulation

boolean

items.contactProfilesOption

enum<string>

Option to enable or customize Contact profiles selection for the AI Agent.

Available options:

none,

selectedProfileFields,

completeProfile,

profileMemoriesOnly

Example:

"selectedProfileFields"

items.contactProfilesSelected

string[]

Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.

Example:

["name", "email"]

items.instructions

string

Instructions for the AI Agent.

Maximum string length: 1000

Example:

"I can help you with your questions, provide information and much more."

items.createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

items.lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

items.createdBy

string

Required string length: 24

items.lastChangedBy

string

Required string length: 24

items.nodeId

string

Required string length: 24

total

integer

Example:

2

Generate Output for a node using generative AI.Generate Output (Adaptive Card or Text) for a node using generative AI.

⌘I

Get AI Agents used in the specified Flow

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/aiagents?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --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,
      "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
}

Overview

API

Authorizations

Headers

Path Parameters

Query Parameters

Response