Skip to main content
GET
Get a simulation chat

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

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

Path Parameters

simulationChatId
string
required

ID of the simulation chat.

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