Skip to navigation

Create conversation

Alpha
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.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
agentobjectRequired
The agent that runs the turns.
environmentstringOptional

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

user_idstringOptional

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

dynamic_variablesmap from strings to anyOptional

Response

Successful Response
conversation_idstring

Errors

422
Conversations Create Request Unprocessable Entity Error