v5
latestOpenAPI 3.1.02026-08-043621,4011.8 MBAgents Platform
Simulates A Conversation
Deprecated. Use the /v1/convai/agent-testing/create and /v1/convai/agents/:agent_id/run-tests endpoints to create and run simulations. Run a conversation between the agent and a simulated user.
post/v1/convai/agents/{agent_id}/simulate-conversation
Path parameters
agent_idstring required
The id of an agent. This is returned on agent creation.
Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz
The id of an agent. This is returned on agent creation.
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
Response
Successful Response