provider Agents Platform POST /v1/convai/agents/{agent_id}/simulate-conversation/stream
@utdk/elevenlabs /v1/convai/agents/{agent_id}/simulate-conversation/stream
Simulates A Conversation (Stream)
Run a conversation between the agent and a simulated user and stream back the response. Response is streamed back as partial lists of messages that should be concatenated and once the conversation has complete a single final message with the conversation analysis will be sent.
agent_id path required
The id of an agent. This is returned on agent creation.
string
xi-api-key header
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.

Try it

Authentication
Configure credentials for ElevenLabs API Documentation
runConversationSimulationRouteStream
POST/v1/convai/agents/{agent_id}/simulate-conversation/stream
Run a conversation between the agent and a simulated user and stream back the response. Response is streamed back as partial lists of messages that should be concatenated and once the conversation has complete a single final message with the conversation analysis will be sent.

Parameters

required

The id of an agent. This is returned on agent creation.

Input

required

A specification that will be used to simulate a conversation between an agent and an AI user.

A list of evaluation criteria to test

Maximum number of new turns to generate in the conversation simulation

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import elevenlabs from '@utdk/elevenlabs';

await elevenlabs.runConversationSimulationRouteStream({
  "new_turns_limit": 10000
})