Simulation
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:GetSimulationPersonapermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The IDs of the simulation personas 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 to retrieve. Each value must be of the format org_id,user_id.
[]The tags of the simulation personas to retrieve. Each value must be of the format key:value. 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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/persona/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_personas": [
{
"id": "text",
"name": "text",
"role": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"is_deleted": true,
"created_at": "2025-11-13T18:51:19.985Z",
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_at": "2025-11-13T18:51:19.985Z",
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
],
"has_more": true,
"continuation_token": null,
"filter_values": {
"creators": [
{
"org_id": "text",
"user_id": "text"
}
],
"tags": [
"text"
],
"roles": [
"text"
]
}
}Create a simulation persona.
Permissions
Simulation:CreateSimulationPersonafor the persona to create.Simulation:ModifySimulationPersonafor the persona to create.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization was not found.
A simulation persona with this name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 100 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/persona/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"name": "text",
"role": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"initial_version": {
"background": "text",
"preferred_language": "aaa",
"timezone": "Africa/Abidjan",
"user_models": [
"text"
]
}
}{
"simulation_persona_id": "text"
}Get simulation persona versions
Retrieve versions of a simulation persona.
Permissions
This endpoint requires the following permissions:
Simulation:GetSimulationPersonafor the simulation persona.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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 versions.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation persona does not exist.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/persona/{simulation_persona_id}/version/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_persona_versions": [
{
"_id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:51:19.985Z",
"updated_at": "2025-11-13T18:51:19.985Z",
"simulation_persona_id": "text",
"version": 1,
"background": "text",
"preferred_language": "text",
"timezone": "text",
"user_models": [
"text"
]
}
],
"has_more": true,
"continuation_token": null
}Create a new simulation persona version
Create a new version of the simulation persona.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationPersonafor the simulation persona.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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-3 format. If unspecified, the preferred language of the organization is used. If that is unspecified too, the language of the agent is used.
{}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.
A list of strings representing the user models associated with the simulation persona.
Succeeded.
The specified version number is not the expected next version to be created.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation persona does not exist.
Invalid request path parameter, request query parameter, or request body failed validation.
The user has exceeded the rate limit of 100 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/persona/{simulation_persona_id}/version/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"background": "text",
"preferred_language": "aaa",
"timezone": "Africa/Abidjan",
"user_models": [
"text"
]
}{
"version": 1
}Update a simulation persona.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationPersonafor the persona to update.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation persona does not exist.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 100 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/persona/{simulation_persona_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}No content
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:DeleteSimulationPersonaon the simulation persona to delete.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
The specified simulation persona is used in a simulation unit test.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation persona does not exist.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 100 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/simulation/persona/{simulation_persona_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
No content
Get simulation scenario versions
Retrieve the versions of a simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:GetSimulationScenariofor the simulation scenario.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation scenario does not exist.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_scenario_versions": [
{
"_id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:51:19.985Z",
"updated_at": "2025-11-13T18:51:19.985Z",
"simulation_scenario_id": "text",
"version": 1,
"objective": "text",
"instructions": "text",
"initial_message_type": "user-message",
"conversation_starts_at": "2025-11-13T18:51:19.985Z"
}
],
"has_more": true,
"continuation_token": null
}Create a new simulation scenario version
Create a new version of the simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationScenariofor the simulation scenario.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
The initial message type for the simulation scenario version.
The time at which the conversation starts. This must be a timestamp in UTC. If not specified, the current server time is used.
Succeeded.
The specified version number is not the expected next version to be created.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation scenario does not exist.
Invalid request path parameter, request query parameter, or request body failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"objective": "text",
"instructions": "text",
"initial_message_type": "user-message",
"conversation_starts_at": "2025-11-13T18:51:19.985Z"
}{
"version": 1
}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:GetSimulationScenariopermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The IDs of the simulation scenarios 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 to match any value. 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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 200 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/scenario/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_scenarios": [
{
"id": "text",
"name": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"is_deleted": true,
"created_at": "2025-11-13T18:51:19.985Z",
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_at": "2025-11-13T18:51:19.985Z",
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
],
"has_more": true,
"continuation_token": null,
"filter_values": {
"creators": [
{
"org_id": "text",
"user_id": "text"
}
],
"tags": [
"text"
]
}
}Create a simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationScenariofor the simulation scenario.Simulation:ModifySimulationScenariofor the simulation scenario.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization was not found.
A simulation scenario with this name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/scenario/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 208
{
"name": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"initial_version": {
"objective": "text",
"instructions": "text",
"initial_message_type": "user-message",
"conversation_starts_at": "2025-11-13T18:51:19.985Z"
}
}{
"simulation_scenario_id": "text"
}Update a simulation scenario.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationScenarioon the simulation scenario.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation scenario does not exist.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/scenario/{simulation_scenario_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}No content
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:DeleteSimulationScenarioon the simulation scenario to delete.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded
The specified simulation scenario is used in a simulation unit test.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation scenario does not exist.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/simulation/scenario/{simulation_scenario_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
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:GetSimulationPersonapermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/persona/search?query=text HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_personas": [
{
"id": "text",
"name": "text",
"role": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"is_deleted": true,
"created_at": "2025-11-13T18:51:19.985Z",
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_at": "2025-11-13T18:51:19.985Z",
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
]
}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:GetSimulationScenariopermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/scenario/search?query=text HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_scenarios": [
{
"id": "text",
"name": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"is_deleted": true,
"created_at": "2025-11-13T18:51:19.985Z",
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_at": "2025-11-13T18:51:19.985Z",
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
]
}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:GetSimulationUnitTestpermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The IDs of the simulation unit tests 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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 200 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/unit_test/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_unit_tests": [
{
"id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:51:19.985Z",
"updated_at": "2025-11-13T18:51:19.985Z",
"name": "text",
"description": "text",
"service_id": "text",
"service_version_set_name": "text",
"persona_id": "text",
"scenario_id": "text",
"max_interactions": 1,
"success_criterions": [
{
"name": "text",
"metric_id": "text",
"criterion": {
"type": "text",
"expected_value": true
}
}
],
"is_deleted": true,
"tags": [
{
"key": "text",
"value": "text"
}
],
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
],
"has_more": true,
"continuation_token": 1,
"filter_values": {
"creators": [
{
"org_id": "text",
"user_id": "text"
}
],
"tags": [
"text"
],
"service_ids": [
"text"
],
"persona_ids": [
"text"
],
"scenario_ids": [
"text"
],
"metric_ids": [
"text"
]
}
}Create a new simulation unit test.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationUnitTestfor the unit test to create.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
The metric type of the success criterion does not match the metric type of the metric.
Invalid authorization credentials.
Missing required permissions.
The specified organization, service, persona, scenario, metric, or service version set was not found.
A unit test with this name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/unit_test/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 306
{
"name": "text",
"description": "text",
"service_id": "text",
"service_version_set_name": "text",
"persona_id": "text",
"scenario_id": "text",
"max_interactions": 1,
"success_criterions": [
{
"name": "text",
"metric_id": "text",
"criterion": {
"type": "text",
"verb": "==",
"threshold": 1
}
}
],
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"simulation_unit_test_id": "text"
}Modify the specified simulation unit test.
Permissions
Simulation:ModifySimulationUnitTestfor the unit test to update.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
The metric type of the success criterion does not match the metric type of the metric.
Invalid authorization credentials.
Missing required permissions.
The specified organization, simulation unit test, service, persona, scenario, metric, or service version set was not found.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/unit_test/{simulation_unit_test_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 306
{
"description": "text",
"service_id": "text",
"service_version_set_name": "text",
"persona_id": "text",
"scenario_id": "text",
"max_interactions": 1,
"success_criterions": [
{
"name": "text",
"metric_id": "text",
"criterion": {
"type": "text",
"verb": "==",
"threshold": 1
}
}
],
"run_count": 1,
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}No content
Delete a simulation unit test
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:DeleteSimulationUnitTestfor the simulation unit test to delete.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
The specified simulation unit test is used in a simulation unit test set.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation unit test was not found or is inactive.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/simulation/unit_test/{simulation_unit_test_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
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:GetSimulationUnitTestpermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/unit_test/search/?query=text HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_unit_tests": [
{
"_id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:51:19.985Z",
"updated_at": "2025-11-13T18:51:19.985Z",
"name": "text",
"description": "text",
"service_id": "text",
"service_version_set_name": "text",
"persona_id": "text",
"scenario_id": "text",
"max_interactions": 1,
"success_criterions": [
{
"name": "text",
"metric_id": "text",
"criterion": {
"type": "text",
"expected_value": true
}
}
],
"is_deleted": true,
"tags": [
{
"key": "text",
"value": "text"
}
],
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
]
}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:GetSimulationUnitTestSetpermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The IDs of the simulation unit test sets 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.
[]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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/unit_test_set/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_unit_test_sets": [
{
"id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:51:19.985Z",
"updated_at": "2025-11-13T18:51:19.985Z",
"name": "text",
"description": "text",
"unit_test_runs": [
{
"unit_test_id": "text",
"run_count": 1
}
],
"last_triggered_run_id": "text",
"is_deleted": true,
"tags": [
{
"key": "text",
"value": "text"
}
],
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
],
"has_more": true,
"continuation_token": 1,
"filter_values": {
"creators": [
{
"org_id": "text",
"user_id": "text"
}
],
"unit_test_ids": [
"text"
],
"tags": [
"text"
]
}
}Create a new simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:CreateSimulationUnitTestSetfor the simulation unit test set.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or unit test was not found.
A simulation unit test set with the same name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/unit_test_set/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"name": "text",
"description": "text",
"unit_test_runs": [
{
"unit_test_id": "text",
"run_count": 1
}
],
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"simulation_unit_test_set_id": "text"
}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:GetSimulationUnitTestSetpermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/unit_test_set/search/?query=text HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_unit_test_sets": [
{
"_id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:51:19.985Z",
"updated_at": "2025-11-13T18:51:19.985Z",
"name": "text",
"description": "text",
"unit_test_runs": [
{
"unit_test_id": "text",
"run_count": 1
}
],
"last_triggered_run_id": "text",
"is_deleted": true,
"tags": [
{
"key": "text",
"value": "text"
}
],
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
]
}Update a simulation unit test set
Update a simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:ModifySimulationUnitTestSetfor the simulation unit test set.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation unit test set was not found
A simulation unit test set with this name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/unit_test_set/{simulation_unit_test_set_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"name": "text",
"description": "text",
"unit_test_runs": [
{
"unit_test_id": "text",
"run_count": 1
}
],
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}No content
Delete a simulation unit test set
Delete a simulation unit test set.
Permissions
This endpoint requires the following permissions:
Simulation:DeleteSimulationUnitTestSetfor the simulation unit test set.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation unit test set was not found
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/simulation/unit_test_set/{simulation_unit_test_set_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
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:GetSimulationUnitTestSetRunpermission for will be returned.The
unit_test_run_specsandunit_test_run_resultsfields are only populated if the authenticated user has theSimulation:GetSimulationUnitTestSetpermission.The fields
scenario_version_info,persona_version_info,metrics_to_evaluateinunit_test_run_specsand the fieldmetric_evaluation_resultsinunit_test_run_resultsare only populated if the authenticated user has theSimulation:GetSimulationUnitTestpermission.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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 set runs to retrieve. 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.
Filter for simulation unit test set runs created at or after this time (inclusive).
Filter for simulation unit test set runs created at or before this time (inclusive).
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/unit_test_set_run/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"simulation_unit_test_set_runs": [
{
"org_id": "text",
"id": "text",
"is_completed": true,
"simulation_unit_test_set_id": "text",
"failed_metrics": true,
"errored": true,
"artifacts_generated": true,
"unit_test_run_specs": [
{
"unit_test_id": "text",
"run_count": 1,
"service_hierarchical_state_machine_version_info": [],
"agent_version_info": [],
"scenario_version_info": [],
"persona_version_info": [],
"llm_model_preferences": {
"ANY_ADDITIONAL_PROPERTY": {
"llm_name": "text",
"top_p": 1,
"temperature": 1,
"top_k": 1
}
},
"max_interactions": 1,
"metrics_to_evaluate": [
{
"metric_id": "text",
"success_criterion_name": "text",
"success_criterion": {
"type": "text",
"expected_value": true
}
}
]
}
],
"unit_test_run_results": [
{
"unit_test_id": "text",
"metric_evaluation_results": [
{
"metric_id": "text",
"results": [
[]
]
}
],
"run_errors": [
"text"
]
}
],
"created_at": "2025-11-13T18:51:19.985Z",
"creator": {
"org_id": "text",
"user_id": "text"
}
}
],
"has_more": true,
"continuation_token": 1,
"filter_values": {
"creators": [
{
"org_id": "text",
"user_id": "text"
}
],
"simulation_unit_test_set_ids": [
"text"
],
"tags": [
"text"
]
}
}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:CreateSimulationUnitTestSetRunfor the test set run.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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}$Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation unit test set was not found.
The user already has an unfinished run for this simulation unit test set.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/simulation/unit_test_set_run/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"simulation_unit_test_set_id": "text"
}{
"simulation_unit_test_set_run_id": "text"
}Get simulation unit test set run artifacts
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:GetSimulationUnitTestSetRunfor the simulation unit test set run.Organization:GetServiceHierarchicalStateMachinefor the state machine that the simulation uses.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
The artifacts for the unit test set run are not yet available for retrieval
Invalid authorization credentials.
Missing required permissions.
Specified organization or unit test set run is not found.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 100 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/simulation/unit_test_set_run/{simulation_unit_test_set_run_id}/artifacts/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"presigned_url": "text",
"url_expires_at": "2025-11-13T18:51:19.985Z"
}Cancel a simulation unit test set run
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:CancelSimulationUnitTestSetRunfor the authenticated user.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or simulation unit test set run was not found.
The simulation unit test set run is not in progress.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 10 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/simulation/unit_test_set_run/{simulation_unit_test_set_run_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?