v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

AI Agents

Create an AI Agent

Creates an AI Agent in a Project. The request defines the AI Agent persona (name, description, avatar), behavioral instructions, speaking style, and safety settings. You can optionally link the AI Agent to a Knowledge Store, configure voice and text-to-speech settings, and control whether voice configurations are activated. The method returns the newly created AI Agent, including its unique ID and metadata such as creation timestamps and author information.

post/v2.0/aiagents

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.

Request body

namestring

imagestring

Avatar of the AI Agent.

imageOptimizedFormatboolean

Whether the optimized image format defined by Cognigy is used.

knowledgeReferenceIdstring uuid nullable

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

descriptionstring

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

enableVoiceConfigsboolean

Enables the use of voice configuration.

enableAutoLanguageDetectionboolean

Whether the AI Agent should automatically detect and respond in the user's language.

contactProfilesOption'none' | 'selectedProfileFields' | 'completeProfile' | 'profileMemoriesOnly'

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

contactProfilesSelectedstring[]

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

instructionsstring

Instructions for the AI Agent.

projectIdstring

The unique identifier for the Project.

Example request

{
  "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."
}

Response

Returns the AI Agent object.