AMamigo
Simulation

Create a new simulation scenario version

Create a new version of the simulation scenario.

Permissions

This endpoint requires the following permissions:

  • Simulation:ModifySimulationScenario for the simulation scenario.
post/v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/

Request

Path parameters

organizationstring required
simulation_scenario_idstring required

The ID of the simulation scenario to create a version for.

Query parameters

versioninteger nullable

The version number of the new version. If specified, this endpoint throws an error if the next version in the database doesn't equal to the value of this parameter.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

objectivestring required
instructionsstring required
initial_message_type'user-message' | 'external-event' | 'skip' required
conversation_starts_atstring date-time nullable required

The time at which the conversation starts. This must be a timestamp in UTC. If not specified, the current server time is used.

Response

Succeeded.

versioninteger required

The version number of the created simulation scenario version.

Changes

No operation changes recorded.