Agents Platform

Simulates A Conversation (Stream)

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 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

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.

Request body

new_turns_limitinteger

Maximum number of new turns to generate in the conversation simulation

Response

Successful Response

Changes

Changed in 15 of the 32 revisions of this API.31359

Sep 4, 2026d393c67c384a929See the full diff
- ▲
  removed from the /////// request property anyOf list
  request-property-any-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ○
  added the new optional request property /////////
  new-optional-request-property
- ○
  added the new optional request property ////////////
  new-optional-request-property
- ○
  added the new optional request property //////////////
  new-optional-request-property
- ○
  added the new optional request property ////////////
  new-optional-request-property
- ○
  added the new optional request property //////////////
  new-optional-request-property
- ○
  added the new optional request property ///////////
  new-optional-request-property
- ○
  added the new optional request property /////////////
  new-optional-request-property
- ○
  added the new optional request property ///////////
  new-optional-request-property
- ○
  added the new optional request property /////////////
  new-optional-request-property
- ○
  added to the /////// request property anyOf list
  request-property-any-of-added
- ○
  request property ///////// deprecated
  request-property-deprecated
- ○
  request property //////////// deprecated
  request-property-deprecated
- ○
  request property ////////////// deprecated
  request-property-deprecated
- ○
  request property //////////// deprecated
  request-property-deprecated
- ○
  request property ////////////// deprecated
  request-property-deprecated
- ○
  request property /////////// deprecated
  request-property-deprecated
- ○
  request property ///////////// deprecated
  request-property-deprecated
- ○
  request property /////////// deprecated
  request-property-deprecated
- ○
  request property ///////////// deprecated
  request-property-deprecated
- ○
  added create_product_quote_request create_service_quote_request send_custom_email discriminator mapping keys to the ////// request property
  request-property-discriminator-mapping-added
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  removed run_subagent discriminator mapping keys from the ////// request property
  request-property-discriminator-mapping-deleted
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 2, 2026630c650dda663See the full diff
- ○
  added the new optional request property ////
  new-optional-request-property
- ○
  added the new optional request property //////
  new-optional-request-property
- ○
  added the new optional request property //////
  new-optional-request-property
Aug 31, 2026aa277505183c824See the full diff
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the ////// request property oneOf list
  request-property-one-of-removed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ////// request property
  request-property-discriminator-mapping-changed
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 27, 2026f366bca2ae3c9See the full diff
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new optional request property //////////
  new-optional-request-property
- ○
  added the new dtmf enum value to the request property ////
  request-property-enum-value-added
Aug 25, 2026311280aae31f2See the full diff
- ○
  added cancel_order create_order get_client_orders get_order_by_confirmation_number update_order discriminator mapping keys to the ////// request property
  request-property-discriminator-mapping-added
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
Aug 19, 2026f053c821dc1828See the full diff
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
Aug 15, 2026acb0175c05254See the full diff
- ○
  added the new gemini-3.7-flash enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new gemini-3.7-flash enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new gemini-3.7-flash enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new gemini-3.7-flash enum value to the request property ///
  request-property-enum-value-added
Aug 11, 2026d1a4847203ce5See the full diff
- ○
  added the new avaya enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new gemini-3.6-flash enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new gemini-3.6-flash enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new gemini-3.6-flash enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new gemini-3.6-flash enum value to the request property ///
  request-property-enum-value-added
Aug 8, 2026e77a0a530a8218See the full diff
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  the request property default value changed from false to true
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
- ○
  the request property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite
  request-property-default-value-changed
Aug 6, 20261cae8adcc9658See the full diff
- ○
  the request property default value gemini-2.5-flash was removed
  request-property-default-value-removed
- ○
  the request property default value gemini-2.5-flash was removed
  request-property-default-value-removed
- ○
  the request property default value gemini-2.5-flash was removed
  request-property-default-value-removed
- ○
  added create_transfer_rule delete_transfer_rule list_transfer_rules update_transfer_rule discriminator mapping keys to the ////// request property
  request-property-discriminator-mapping-added
- ○
  added the new audiocodes enum value to the request property ////
  request-property-enum-value-added
- ○
  the ////// request property's max was increased from 120.00 to 300.00
  request-property-max-increased
- ○
  the ////// request property's max was increased from 120.00 to 300.00
  request-property-max-increased
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added

Full history (15 revisions)