Generate a scenario

This endpoint generates a scenario from a user_prompt, along with an optional chat_identifier, current_scenario, and scenario_configuration_type. The response is a stream of server-sent events (text/event-stream): zero or more THINKING events with the agent's progress, then one COMPLETED or FAILED event with the result. To refine the scenario, send the chat_identifier from the last COMPLETED event and, if you edited it, the scenario as current_scenario. The generated scenario is not saved; it must be created separately.

You need the "Create artifacts using the Artifact Builder." and "Create and update scenarios" permissions to use this endpoint.

Body Params
uuid

Continues a chat. Send the chat_identifier from the most recent response: every response returns a new one. An earlier one continues from that point and ignores the turns after it. Omit it to start a new chat.

current_scenario
object

A scenario: a plain-language description and its specification.

string
enum
Defaults to TRANSACTION_MONITORING

The product type for the scenario being generated. Defaults to TRANSACTION_MONITORING when omitted, ensuring backwards compatibility with existing callers.

Allowed:
string
required
length between 0 and 2000

A natural language instruction. It explains what the scenario should cover.

Headers
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/event-stream
application/problem+json