Stream simulate conversation

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.

Path parameters

agent_idstringRequired

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

Request

This endpoint expects an object.

simulation_specificationobjectRequired

A specification detailing how the conversation should be simulated

extra_evaluation_criterialist of objects or nullOptional

A list of evaluation criteria to test

new_turns_limitintegerOptionalDefaults to 10000

Maximum number of new turns to generate in the conversation simulation

Response

Successful Response

Errors

422

Unprocessable Entity Error

$	curl -X POST https://api.elevenlabs.io/v1/convai/agents/agent_id/simulate-conversation/stream \
>	-H "Content-Type: application/json" \
>	-d '{
>	"simulation_specification": {
>	"simulated_user_config": {
>	"first_message": "Hello, how can I help you today?",
>	"language": "en",
>	"disable_first_message_interruptions": false
>	}
>	}
>	}'

$	curl -X POST https://api.elevenlabs.io/v1/convai/agents/agent_id/simulate-conversation/stream \
>	-H "Content-Type: application/json" \
>	-d '{
>	"simulation_specification": {
>	"simulated_user_config": {
>	"first_message": "Hello, how can I help you today?",
>	"language": "en",
>	"disable_first_message_interruptions": false
>	}
>	}
>	}'

Stream simulate conversation

Path parameters

Headers

Request

Response

Errors

Path parameters

Headers

Request

Response

Errors