Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Create a new simulation persona version

Create a new version of the simulation persona.

Permissions

This endpoint requires the following permissions:

  • Simulation:ModifySimulationPersona for the simulation persona.
post/v1/{organization}/simulation/persona/{simulation_persona_id}/version/

Path parameters

simulation_persona_idstring required

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

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

organizationstring required

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.

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.

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

backgroundstring required
user_modelsAmigoLibPydanticBaseModelStrippedNonemptyString1[] required

A list of strings representing the user models associated with the simulation persona.

nonsensitive_user_variablesobject required

A dictionary of the simulation persona's nonsensitive user variables that are provided to the tools.

sensitive_user_variablesobject required

A dictionary of the simulation persona's sensitive user variables that are provided to the tools. Unlike the ones in the user collection, these are not encrypted, so only sensitive information in staging environment should be stored here.

Response

Succeeded.

versioninteger required

The version number of the created simulation persona version.