V1/simulation
Was this helpful?
Was this helpful?
Retrieve versions of a simulation persona.
Permissions
This endpoint requires the following permissions:
Simulation:GetSimulationPersona for the simulation persona.
The ID of the simulation persona to get versions for.
^[a-f0-9]{24}$The versions of the simulation persona to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.
1The maximum number of simulation persona versions to return.
10The continuation token from the previous request used to retrieve the next page of simulation persona version.
0The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]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.
Delete a simulation persona. This endpoint only soft-deletes the simulation persona so any existing references to it would still be valid. However, they cannot be used in any new simulations.
This endpoint will error if the simulation persona is used in any simulation unit tests.
Permissions
This endpoint requires the following permissions:
Simulation:DeleteSimulationPersona on the simulation persona to delete.
The ID of the simulation persona to delete.
^[a-f0-9]{24}$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.
No content
Retrieve the versions of a simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:GetSimulationScenario for the simulation scenario.
The ID of the simulation scenario to get versions for.
^[a-f0-9]{24}$The versions of the simulation scenario to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.
1The maximum number of simulation scenario versions to return.
10The continuation token from the previous request used to retrieve the next page of simulation scenario version.
0The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]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.
Retrieve simulation scenarios that match the given filters.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation scenarios that the authenticated user has Simulation:GetSimulationScenario permission for will be retrieved.
The ID of the simulation scenario to retrieve.
The maximum number of simulation scenarios to return.
50The continuation token from the previous request used to retrieve the next page of simulation scenarios.
0Whether the simulation scenario is deleted.
The creators of the simulation scenarios. Each value must be of the format org_id,user_id.
[]The tags of the simulation scenarios. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The fields to sort the sets by. Supported fields are updated_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]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.
Delete a simulation scenario. This endpoint only soft-deletes the simulation scenario so any existing references to it would still be valid. However, they cannot be used in any new simulations.
This endpoint will error if the simulation scenario is used in any simulation unit tests.
Permissions
This endpoint requires the following permissions:
Simulation:DeleteSimulationScenario on the simulation scenario to delete.
The ID of the simulation scenario to delete.
^[a-f0-9]{24}$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.
No content
Search for simulation personas that match the given filters and contain the given query in its name and the background of its latest version. Only the top 50 results will be returned. The results will be sorted by the relevance of the search query.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation personas that the authenticated user has Simulation:GetSimulationPersona permission for will be retrieved.
The query to search for. Any simulation personas containing the terms in its name and the background of its latest version would be returned.
The roles of the simulation personas.
[]The creators of the simulation personas. Each value must be of the format org_id,user_id.
[]The tags of the simulation personas. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]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.
Search for simulation scenarios that match the given filters and contain the given query in its name. Only the top 50 results will be returned. The results will be sorted by the relevance of the search query.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation scenarios that the authenticated user has Simulation:GetSimulationScenario permission for will be retrieved.
The query to search for. Any simulation scenarios containing the terms in its name would be returned.
The creators of the simulation scenarios. Each value must be of the format org_id,user_id.
[]The tags of the simulation scenarios. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]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.
Retrieve the simulation unit tests that match the given filters.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation unit tests that the authenticated user has Simulation:GetSimulationUnitTest permission for will be retrieved.
The ID of the simulation unit test to retrieve.
[]The maximum number of simulation unit tests to return.
50The continuation token from the previous request used to retrieve the next page of simulation unit tests.
0Whether the simulation unit test is deleted.
The IDs of the services that the simulation unit tests run on.
[]The IDs of the personas that the simulation unit tests use.
[]The IDs of the scenarios that the simulation unit tests use.
[]The IDs of the metrics that the simulation unit tests use.
[]The creators of the simulation unit tests. Each value must be of the format org_id,user_id.
[]The tags of the simulation unit tests. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The fields to sort the sets by. Supported fields are updated_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]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.
Delete a simulation unit test. The unit test is soft-deleted and all references to it are still valid. Any scheduled unit test runs would still continue as expected, but no new run can be created.
This endpoint will error if the simulation unit test is used in any simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:DeleteSimulationUnitTest for the simulation unit test to delete.
The ID of the simulation unit test to delete.
^[a-f0-9]{24}$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.
No content
Search for simulation unit tests that match the given filters and whose name or description contains the specified query.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation unit tests that the authenticated user has Simulation:GetSimulationUnitTest permission for will be retrieved.
The query to search for. Any simulation unit tests containing the terms in its name would be returned.
The creators of the simulation unit tests. Each value must be of the format org_id,user_id.
[]The tags of the simulation unit tests. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The IDs of the services that the simulation unit tests run on.
[]The IDs of the personas that the simulation unit tests use.
[]The IDs of the scenarios that the simulation unit tests use.
[]The IDs of the metrics that the simulation unit tests use.
[]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.
Retrieve the simulation unit test sets that match the given filters.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation unit test sets that the authenticated user has Simulation:GetSimulationUnitTestSet permission for will be retrieved.
The ID of the simulation unit test set to retrieve.
[]The maximum number of simulation unit test sets to return.
20The continuation token from the previous request used to retrieve the next page of simulation unit test sets.
0Whether the simulation unit test set is deleted.
The IDs of the unit tests that are part of the simulation unit test sets.
[]The creators of the simulation unit test sets. Each value must be of the format org_id,user_id.
[]The tags of the simulation unit test sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The fields to sort the sets by. Supported fields are updated_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]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.
Search for simulation unit test sets that match the given filters and whose name or description contains the specified query.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation unit test sets that the authenticated user has Simulation:GetSimulationUnitTestSet permission for will be retrieved.
The query to search for. Any simulation unit test sets containing the terms in its name or description would be returned.
The creators of the simulation unit test sets. Each value must be of the format org_id,user_id.
[]The tags of the simulation unit test sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The IDs of the unit tests that are part of the simulation unit test sets.
[]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.
Delete a simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:DeleteSimulationUnitTestSet for the simulation unit test set.
The ID of the simulation unit test set to delete.
^[a-f0-9]{24}$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.
No content
Retrieves simulation unit test set runs.
This endpoint may be impacted by the following permissions:
Only the runs that the authenticated user has the Simulation:GetSimulationUnitTestSetRun permission for will be returned.
The unit_test_run_specs and unit_test_run_results fields are only populated if the authenticated user has the Simulation:GetSimulationUnitTestSet permission.
The fields scenario_version_info, persona_version_info, metrics_to_evaluate in unit_test_run_specs and the field metric_evaluation_results in unit_test_run_results are only populated if the authenticated user has the Simulation:GetSimulationUnitTest permission.
The fields metric_name and metric_value in metrics_to_evaluate are only populated if the authenticated user has the Metric:GetMetric permission.
The ID of the simulation unit test set run to retrieve.
[]The maximum number of simulation unit test set runs to return.
50The continuation token from the previous request used to retrieve the next page of simulation unit test set runs.
0The creators of the simulation unit test sets. Each value must be of the format org_id,user_id.
[]The fields to sort the sets by. Supported fields are created_at.
[]The IDs of the simulation unit test sets that the simulation unit test set runs belong to.
[]Whether the simulation unit test set run is completed.
Whether the simulation unit test set run has failed due to failing metrics. Note that this field could be True even if the run is still ongoing -- it simply means some unit test runs have failed.
Whether the simulation unit test set run has encountered an error.
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.
Get the artifacts of a simulation unit test set run. A link to the raw artifacts in S3 is returned.
Permissions
This endpoint requires the following permissions:
Simulation:GetSimulationUnitTestSetRun for the simulation unit test set run.
Organization:GetServiceHierarchicalStateMachine for the state machine that the simulation uses.
The ID of the simulation unit test set run to retrieve the artifacts of.
^[a-f0-9]{24}$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.
Cancel a simulation unit test set run. The run must still be in progress. This cancellation is a best-effort operation, and there's no guarantee that it'll take effect immediately.
Permissions
This endpoint requires the following permissions:
Simulation:CancelSimulationUnitTestSetRun for the authenticated user.
The ID of the simulation unit test set run to cancel.
^[a-f0-9]{24}$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.
No content
Retrieve simulation personas that match the given filters.
Permissions
This endpoint may be impacted by the following permissions:
Only simulation personas that the authenticated user has Simulation:GetSimulationPersona permission for will be retrieved.
The ID of the simulation persona to retrieve.
The maximum number of simulation personas to return.
50The continuation token from the previous request used to retrieve the next page of simulation personas.
0Whether the simulation persona is deleted.
The roles of the simulation personas.
[]The creators of the simulation personas. Each value must be of the format org_id,user_id.
[]The tags of the simulation personas. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The fields to sort the sets by. Supported fields are updated_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]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.
Create a simulation persona.
Permissions
Simulation:CreateSimulationPersona for the persona to create.
Simulation:ModifySimulationPersona for the persona to create.
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 name of the simulation persona.
The role of the simulation persona.
Create a new version of the simulation persona.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationPersona for the simulation persona.
The ID of the simulation persona to create a version for.
^[a-f0-9]{24}$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 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 background of the simulation persona.
The preferred language of the simulation persona in the ISO 639-1 alpha-2 format. If unspecified, the preferred language of the organization is used. If that is unspecified too, the language of the agent is used.
{}^\w{2}$A specific type to indicate that a field is not set in the request.
The timezone of the simulation persona in the IANA tz database format. If unspecified, the organization's default timezone is used. If the organization's default timezone is not specified, UTC is used.
{}A specific type to indicate that a field is not set in the request.
Update a simulation persona.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationPersona for the persona to update.
The ID of the simulation persona to update
^[a-f0-9]{24}$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 tags of the simulation persona. Both the key and the value can only contain alphanumeric characters, underscores, or spaces.
No content
Create a new version of the simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationScenario for the simulation scenario.
The ID of the simulation scenario to create a version for.
^[a-f0-9]{24}$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 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 objective of the simulation scenario.
The instructions of the simulation scenario.
Create a simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationScenario for the simulation scenario.
Simulation:ModifySimulationScenario for the simulation scenario.
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 name of the simulation scenario.
Update a simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationScenario on the simulation scenario.
The ID of the simulation scenario to update.
^[a-f0-9]{24}$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 tags of the simulation persona. Both the key and the value can only contain alphanumeric characters, underscores, or spaces.
No content
Create a new simulation unit test.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationUnitTest for the unit test to create.
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 name of the unit test.
A description of the unit test.
The service that the unit test runs on.
^[a-f0-9]{24}$The version set of the service that the unit test runs on.
The persona that unit test uses.
^[a-f0-9]{24}$The scenario that the unit test uses.
^[a-f0-9]{24}$The max number of interactions after which the unit test fails.
Modify the specified simulation unit test.
Permissions
Simulation:ModifySimulationUnitTest for the unit test to update.
The ID of the simulation unit test to update.
^[a-f0-9]{24}$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.
A description of the unit test.
The service that the unit test runs on.
^[a-f0-9]{24}$The version set of the service that the unit test runs on.
The persona that unit test uses.
^[a-f0-9]{24}$The scenario that the unit test uses.
^[a-f0-9]{24}$The max number of interactions after which the unit test fails.
The success criterions for the unit test.
Each time this unit test is run, the number of sessions to simulate.
The tags of the simulation persona.
No content
Create a new simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationUnitTestSet for the simulation unit test set.
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 name of the simulation unit test set.
The description of the simulation unit test set.
Update a simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationUnitTestSet for the simulation unit test set.
The ID of the simulation unit test set to update.
^[a-f0-9]{24}$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 name of the simulation unit test set.
The description of the simulation unit test set. If not specified or an empty object is provided, the description will not be updated.
{}A specific type to indicate that a field is not set in the request.
The unit test runs that are part of this set.
The tags of the simulation unit test set.
No content
Create a run for a simulation unit test set. The user must not already have an unfinished run for this simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationUnitTestSetRun for the test set run.
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 ID of the simulation unit test set to run.
^[a-f0-9]{24}$