Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Create Agent

Create an agent from a config object

post/v1/convai/agents/create

Query parameters

enable_versioningboolean

Deprecated: all agents are versioned. This parameter is ignored.

Deprecated: all agents are versioned. This parameter is ignored.

Headers

xi-api-keystring nullable

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.

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.

Request body

namestring nullable

A name to make the agent easier to find

tagsstring[] nullable

Tags to help classify and filter the agent

Response

Successful Response

agent_idstring required

ID of the created agent

Example response

{
  "agent_id": "J3Pbu5gP6NNKBscdCdwB"
}