Agents Platform

Create Conversation

Changed on

Create a text conversation with an agent. This does not run the agent, and the agent sends no first message. This endpoint is in alpha and may change.

post/v1/convai/conversations

Request

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.

Request body

environmentstring nullable

The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to the branch's environment, then 'production'.

user_idstring nullable

ID of the end user participating in this conversation (for agent owner's user identification)

dynamic_variablesobject

Response

Successful Response

conversation_idstring required

Changes