---
title: "Get an AI Agent"
method: GET
path: "/v2.0/aiagents/{aiAgentId}"
tags: ["AI Agents"]
---

# Get an AI Agent

`GET /v2.0/aiagents/{aiAgentId}`

Gets an AI Agent from a Project. Returns the AI Agent configuration, including identity, description, avatar, instructions, speaking style, voice, safety settings, and metadata such as creation and modification timestamps.

## Path parameters

- `aiAgentId` string, required

## Headers

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

## Response `200`

Returns AI agent object.

- object — The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
  - `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.
  - `_id` string
  - `createdAt` integer — Unix-timestamp
  - `lastChanged` integer — Unix-timestamp
  - `createdBy` string
  - `lastChangedBy` string

## 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)