Skip to main content
POST
Create Agent

Authorizations

x-api-key
string
header
required

API key for programmatic access

Headers

xi-api-key
string | null

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Query Parameters

enable_versioning
boolean
default:false

Enable versioning for the agent

Body

application/json

Request body for POST /v1/convai/agents/create.

conversation_config
ConversationalConfigAPIModel-Input · object
required

Conversation configuration for an agent

platform_settings
AgentPlatformSettingsRequestModel · object | null

Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.

workflow
AgentWorkflowRequestModel · object | null

Workflow for the agent. This is used to define the flow of the conversation and how the agent interacts with tools.

name
string | null

A name to make the agent easier to find

Example:

"My agent"

tags
string[] | null

Tags to help classify and filter the agent

Example:

Response

Successful Response

agent_id
string
required

ID of the created agent