Skip to main content
POST
Start a simulation chat with an agent

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

Api key to pass as a X-Api-Key request header.

Body

agentId
string
required

ID of the agent to test

Minimum string length: 1
dataBag
object | null

Optional values for the agent's fields (the variables used in the prompt), e.g. { "firstName": "Marie" }

toolMocking
object

Which tools of the agent are mocked (not really executed) during a simulation. Every mock is opt-in: nothing is mocked unless asked for here, and mockAllTools does not imply mockCallTransfer. The knowledge base retrieval always runs for real.

Response

Success

State of a simulation chat, returned by SimulationChat/start and GET SimulationChat/{simulationChatId}

simulationChatId
string | null

Identifier of the simulation chat (the conversation id). Pass it to SimulationChat/send-message.

messages
object[] | null

All the messages of the conversation so far, in chronological order

agent
object

An agent: its name, prompt and connected tools