Agents Platform

Simulates A Conversation (Stream)

Changed on

Deprecated. This endpoint will be removed on 31 Oct 2026. 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 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.

post/v1/convai/agents/{agent_id}/simulate-conversation/stream

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/agents/{agent_id}/simulate-conversation/stream
  • Auth
    none declared

Path parameters

agent_idstring required

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

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

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.

Request body

new_turns_limitinteger

Maximum number of new turns to generate in the conversation simulation

Response

Successful Response

Changes

  • 54c5819bbe5dRevision changes
    • warning

      removed the request property ////////

    • warning

      removed the request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added owner_get_client_appointments owner_list_assets owner_list_locations owner_list_products owner_list_services owner_list_staff discriminator mapping keys to the ////// request property

    • info

      added to the ////// request property oneOf list

  • 61de2e1f86c1Revision changes
    • info

      added the new optional request property ///