---
title: "Get AI Agents Nodes"
method: GET
path: "/v2.0/flows/{flowId}/chart/nodes/aiagents"
tags: ["Nodes"]
---

# Get AI Agents Nodes

`GET /v2.0/flows/{flowId}/chart/nodes/aiagents`

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

## Path parameters

- `flowId` string, required

## Query parameters

- `preferredLocaleId` string

## Headers

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

## Response `200`

Returns AI Agents used in the Flow

- object
  - `items` object[]
    - `_id` string
    - `type` string
    - `referenceId` string, uuid
    - `extension` string
    - `label` string
    - `analyticsLabel` string
    - `comment` string
    - `commentColor` union
      - string
      - 'aliceBlue' | 'antiqueWhite' | 'aqua' | 'aquamarine' | 'azure' | 'beige' | 'bisque' | 'black' | 'blanchedAlmond' | 'blue' | 'blueViolet' | 'brown' | 'burlyWood' | 'cadetBlue' | 'chartreuse' | 'chocolate' | 'coral' | 'cornflowerBlue' | 'cornsilk' | 'crimson' | 'cyan' | 'darkBlue' | 'darkCyan' | 'darkGoldenRod' | 'darkGray' | 'darkGrey' | 'darkGreen' | 'darkKhaki' | 'darkMagenta' | 'darkOliveGreen' | 'darkOrange' | 'darkOrchid' | 'darkRed' | 'darkSalmon' | 'darkSeaGreen' | 'darkSlateBlue' | 'darkSlateGray' | 'darkSlateGrey' | 'darkTurquoise' | 'darkViolet' | 'deepPink' | 'deepSkyBlue' | 'dimGray' | 'dimGrey' | 'dodgerBlue' | 'fireBrick' | 'floralWhite' | 'forestGreen' | 'fuchsia' | 'gainsboro' | 'ghostWhite' | 'gold' | 'goldenRod' | 'gray' | 'grey' | 'green' | 'greenYellow' | 'honeyDew' | 'hotPink' | 'indianRed' | 'indigo' | 'ivory' | 'khaki' | 'lavender' | 'lavenderBlush' | 'lawnGreen' | 'lemonChiffon' | 'lightBlue' | 'lightCoral' | 'lightCyan' | 'lightGoldenRodYellow' | 'lightGray' | 'lightGrey' | 'lightGreen' | 'lightPink' | 'lightSalmon' | 'lightSeaGreen' | 'lightSkyBlue' | 'lightSlateGray' | 'lightSlateGrey' | 'lightSteelBlue' | 'lightYellow' | 'lime' | 'limeGreen' | 'linen' | 'magenta' | 'maroon' | 'mediumAquaMarine' | 'mediumBlue' | 'mediumOrchid' | 'mediumPurple' | 'mediumSeaGreen' | 'mediumSlateBlue' | 'mediumSpringGreen' | 'mediumTurquoise' | 'mediumVioletRed' | 'midnightBlue' | 'mintCream' | 'mistyRose' | 'moccasin' | 'navajoWhite' | 'navy' | 'oldLace' | 'olive' | 'oliveDrab' | 'orange' | 'orangeRed' | 'orchid' | 'paleGoldenRod' | 'paleGreen' | 'paleTurquoise' | 'paleVioletRed' | 'papayaWhip' | 'peachPuff' | 'peru' | 'pink' | 'plum' | 'powderBlue' | 'purple' | 'rebeccaPurple' | 'red' | 'rosyBrown' | 'royalBlue' | 'saddleBrown' | 'salmon' | 'sandyBrown' | 'seaGreen' | 'seaShell' | 'sienna' | 'silver' | 'skyBlue' | 'slateBlue' | 'slateGray' | 'slateGrey' | 'snow' | 'springGreen' | 'steelBlue' | 'tan' | 'teal' | 'thistle' | 'tomato' | 'turquoise' | 'violet' | 'wheat' | 'white' | 'whiteSmoke' | 'yellow' | 'yellowGreen' | 'none' | 'transparent'
      - ''
    - `isCollapsed` boolean
    - `isEntryPoint` boolean
    - `isDisabled` boolean
    - `name` string
    - `image` string — Avatar of the AI Agent.
    - `imageOptimizedFormat` boolean — Whether the optimized image format defined by Cognigy is used.
    - `knowledgeReferenceId` string, uuid, nullable — A referenceId of a Knowledge Store this Agent will use as base knowledge or null.
    - `description` string — A short description of the AI Agent, up to 1000 characters.
    - `speakingStyle` object
      - `completeness` string
      - `formality` string
    - `voiceConfigs` object
      - `ttsVoice` string
      - `ttsLanguage` string
      - `ttsVendor` 'aws' | 'deepgram' | 'elevenlabs' | 'google' | 'microsoft' | 'nuance' | 'default' | 'custom' | 'none'
      - `ttsModel` string
      - `ttsLabel` string
      - `ttsDisableCache` boolean
    - `enableVoiceConfigs` boolean — Enables the use of voice configuration.
    - `enableAutoLanguageDetection` boolean — Whether the AI Agent should automatically detect and respond in the user's language.
    - `safetySettings` object
      - `avoidHarmfulContent` boolean
      - `avoidUngroundedContent` boolean
      - `avoidCopyrightInfringements` boolean
      - `preventJailbreakAndManipulation` boolean
    - `contactProfilesOption` 'none' | 'selectedProfileFields' | 'completeProfile' | 'profileMemoriesOnly' — Option to enable or customize Contact profiles selection for the AI Agent.
    - `contactProfilesSelected` string[] — Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
    - `instructions` string — Instructions for the AI Agent.
    - `createdAt` integer — Unix-timestamp
    - `lastChanged` integer — Unix-timestamp
    - `createdBy` string
    - `lastChangedBy` string
    - `nodeId` string
  - `total` integer

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `402` — Upgrade your Plan to increase your Quota.
- `403` — The server understood the request but refuses to authorize it.
- `404` — The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
- `405` — The method received in the request-line is known by the origin server but not supported by the target resource.
- `409` — The request conflicts with current state of the server.
- `413` — The request entity is larger than limits defined by server.
- `500` — The server encountered an unexpected condition that prevented it from fulfilling the request.
- `501` — The server does not support the functionality required to fulfill the request.
- `502` — The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
- `503` — The server is not ready to handle the request.
- `504` — The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

---

[API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/versions/85b2872bdfb7/schema)