How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amigo Simulation API

The Simulation API from Amigo — 17 operation(s) for simulation.

Amigo Simulation API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Simulation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 28 operations across 17 paths, and defines 76 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

28 operations 17 paths 76 schemas 5 DELETE12 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Simulation API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — 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 ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 28

Across 17 paths, the API surfaces 28 operations — 5 DELETE, 12 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Simulation 28
POST
/v1/{organization}/simulation/persona/
Create a simulation persona
create-simulation-persona 3 params body → 201404422409401403503429
GET
/v1/{organization}/simulation/persona/
Get simulation personas
get-simulation-personas 11 params → 200404422401403503429
POST
/v1/{organization}/simulation/persona/{simulation_persona_id}/version/
Create a new simulation persona version
create-simulation-persona-version 5 params body → 201422404400401403503429
GET
/v1/{organization}/simulation/persona/{simulation_persona_id}/version/
Get simulation persona versions
get-simulation-persona-versions 8 params → 200404422401403503429
POST
/v1/{organization}/simulation/persona/{simulation_persona_id}/
Update a simulation persona
update-simulation-persona 4 params body → 204422404401403503429
DELETE
/v1/{organization}/simulation/persona/{simulation_persona_id}/
Delete a simulation persona
delete-simulation-persona 4 params → 204422404400401403503429
GET
/v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/
Get simulation scenario versions
get-simulation-scenario-versions 8 params → 200404422401403503429
POST
/v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/
Create a new simulation scenario version
create-simulation-scenario-version 5 params body → 201422404400401403503429
POST
/v1/{organization}/simulation/scenario/
Create a simulation scenario
create-simulation-scenario 3 params body → 201404422409401403503429
GET
/v1/{organization}/simulation/scenario/
Get simulation scenarios
get-simulation-scenarios 10 params → 200404422401403503429
POST
/v1/{organization}/simulation/scenario/{simulation_scenario_id}/
Update a simulation scenario
update-simulation-scenario 4 params body → 204422404401403503429
DELETE
/v1/{organization}/simulation/scenario/{simulation_scenario_id}/
Delete a simulation scenario
delete-simulation-scenario 4 params → 204422404400401403503429
GET
/v1/{organization}/simulation/persona/search
Search simulation personas
search-simulation-personas 7 params → 200404422401403503429
GET
/v1/{organization}/simulation/scenario/search
Search simulation scenarios
search-simulation-scenarios 6 params → 200404422401403503429
POST
/v1/{organization}/simulation/unit_test/
Create a simulation unit test
create-simulation-unit-test 3 params body → 201422409404400401403503
GET
/v1/{organization}/simulation/unit_test/
Get simulation unit tests
get-simulation-unit-tests 14 params → 200404422401403503429
POST
/v1/{organization}/simulation/unit_test/{simulation_unit_test_id}/
Update a simulation unit test
update-simulation-unit-test 4 params body → 204422404400401403503429
DELETE
/v1/{organization}/simulation/unit_test/{simulation_unit_test_id}/
Delete a simulation unit test
delete-simulation-unit-test 4 params → 204422404400401403503429
GET
/v1/{organization}/simulation/unit_test/search/
Search simulation unit tests
search-simulation-unit-tests 10 params → 200404422401403503429
GET
/v1/{organization}/simulation/unit_test_set/
Get simulation unit test sets
get-simulation-unit-test-sets 11 params → 200404422401403503429
POST
/v1/{organization}/simulation/unit_test_set/
Create a simulation unit test set
create-simulation-unit-test-set 3 params body → 201404422409401403503429
GET
/v1/{organization}/simulation/unit_test_set/search/
Search simulation unit test sets
search-simulation-unit-test-sets 7 params → 200404422401403503429
POST
/v1/{organization}/simulation/unit_test_set/{simulation_unit_test_set_id}
Update a simulation unit test set
update-simulation-unit-test-set 4 params body → 204404422409401403503429
DELETE
/v1/{organization}/simulation/unit_test_set/{simulation_unit_test_set_id}
Delete a simulation unit test set
delete-simulation-unit-test-set 4 params → 204422404401403503429
GET
/v1/{organization}/simulation/unit_test_set_run/
Get simulation unit test set runs
get-simulation-unit-test-set-runs 14 params → 200404422401403503429
POST
/v1/{organization}/simulation/unit_test_set_run/
Create a simulation unit test set run
create-simulation-unit-test-set-run 3 params body → 201404409422401403503429
GET
/v1/{organization}/simulation/unit_test_set_run/{simulation_unit_test_set_run_id}/artifacts/
Get simulation unit test set run artifacts
get-simulation-unit-test-set-run-artifacts 4 params → 200404422400401403503429
DELETE
/v1/{organization}/simulation/unit_test_set_run/{simulation_unit_test_set_run_id}/
Cancel a simulation unit test set run
cancel-simulation-unit-test-set-run 4 params → 204404409422401403503429

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are SimulationUnitTestInstance (16 properties), SimulationUnitTest (16 properties), SimulationPersonaVersion (13 properties), SimulationUnitTestSet (12 properties). Each schema is shown below with its type and property counts.

NumericalMetricSuccessCriterion
object
3 properties 3 required
MetricToEvaluate
object
3 properties 3 required
src__app__endpoints__simulation__create_simulation_scenario__Response
object
1 property 1 required
src__app__endpoints__simulation__create_simulation_persona_version__Request
object
6 properties 4 required
InitialMessageType
string
src__app__endpoints__simulation__get_simulation_personas__Response__FilterValues
object
3 properties 3 required
src__app__endpoints__simulation__create_simulation_unit_test_set_run__Request
object
1 property 1 required
src__app__endpoints__simulation__search_simulation_personas__Response
object
1 property 1 required
src__app__endpoints__simulation__update_simulation_scenario__Request
object
1 property
src__app__endpoints__simulation__search_simulation_scenarios__Response
object
1 property 1 required
src__app__endpoints__simulation__update_simulation_persona__Request
object
1 property
UnitTestRunResult
object
3 properties 3 required
amigo_lib__mongo__collections__simulation_scenario__SimulationScenario__UserInfo
object
2 properties 2 required
src__app__endpoints__simulation__get_simulation_unit_test_set_runs__Response__FilterValues
object
3 properties 3 required
UnitTestRunSpec
object
9 properties 9 required
Tag
object
2 properties 2 required
SuccessCriterionDescription-Output
src__app__endpoints__simulation__create_simulation_unit_test__Request__SuccessCriterion
object
3 properties 3 required
src__app__endpoints__simulation__create_simulation_persona__Request__InitialVersion
object
6 properties 4 required
src__app__endpoints__simulation__get_simulation_unit_test_sets__Response__FilterValues
object
3 properties 3 required
StrippedNonemptyString_a-z___a-z0-9_______
string
SimulationUnitTestSetInstance
object
12 properties 10 required
SimulationUnitTestInstance
object
16 properties 14 required
amigo_lib__mongo__collections__simulation_scenario_version__SimulationScenarioVersion__UserInfo
object
2 properties 2 required
SimulationUnitTestSet
object
12 properties 10 required
src__app__endpoints__simulation__create_simulation_unit_test_set__Request
object
4 properties 4 required
SimulationPersonaVersion
object
13 properties 10 required
StrippedNonemptyString___w__s_____
string
amigo_lib__mongo__collections__simulation_unit_test_set_run__SimulationUnitTestSetRun__UserInfo
object
2 properties 2 required
src__app__endpoints__simulation__create_simulation_persona__Response
object
1 property 1 required
src__app__endpoints__simulation__get_simulation_scenarios__Response__FilterValues
object
2 properties 2 required
src__app__endpoints__simulation__create_simulation_persona__Request
object
4 properties 4 required
_NotSet
object
A specific type to indicate that a field is not set in the request.
CategoricalMetricSuccessCriterion-Output
object
2 properties 2 required
src__app__endpoints__simulation__create_simulation_unit_test_set_run__Response
object
1 property 1 required
src__app__endpoints__simulation__create_simulation_scenario_version__Response
object
1 property 1 required
UnitTestRunDescriptor-Output
object
2 properties 2 required
src__app__endpoints__simulation__create_simulation_unit_test__Request
object
9 properties 9 required
src__app__endpoints__simulation__get_simulation_persona_versions__Response
object
3 properties 3 required
SimulationScenarioVersion
object
11 properties 9 required
src__app__endpoints__simulation__search_simulation_unit_test_set__Response
object
1 property 1 required
src__app__endpoints__simulation__create_simulation_scenario__Request
object
3 properties 3 required
src__app__endpoints__simulation__get_simulation_unit_test_set_runs__Response
object
4 properties 4 required
SimulationUnitTest
object
16 properties 14 required
src__app__endpoints__simulation__update_simulation_unit_test__Request
object
9 properties
amigo_lib__mongo__collections__simulation_persona_version__SimulationPersonaVersion__UserInfo
object
2 properties 2 required
src__app__endpoints__simulation__get_simulation_unit_tests__Response__FilterValues
object
6 properties 6 required
SuccessCriterion-Output
object
3 properties 3 required
LLMConfig-Output
object
2 properties 1 required
BooleanMetricSuccessCriterion
object
2 properties 2 required
src__app__endpoints__simulation__get_simulation_scenario_versions__Response
object
3 properties 3 required
src__app__endpoints__simulation__create_simulation_persona_version__Response
object
1 property 1 required
src__app__endpoints__simulation__get_simulation_unit_tests__Response
object
4 properties 4 required
src__app__endpoints__simulation__get_simulation_personas__Response
object
4 properties 4 required
amigo_lib__mongo__collections__simulation_persona__SimulationPersona__UserInfo
object
2 properties 2 required
SimulationUnitTestSetRunInstance
object
11 properties 11 required
src__app__endpoints__simulation__create_simulation_scenario__Request__InitialVersion
object
4 properties 4 required
UnitTestRunDescriptor-Input
object
2 properties 2 required
SimulationPersonaInstance
object
9 properties 9 required
SuccessCriterionDescription-Input
amigo_lib__pydantic__base_model__StrippedNonemptyString__1
string
src__app__endpoints__simulation__create_simulation_scenario_version__Request
object
4 properties 4 required
src__app__endpoints__simulation__update_simulation_unit_test_set__Request
object
4 properties
src__app__endpoints__simulation__get_simulation_unit_test_sets__Response
object
4 properties 4 required
amigo_lib__mongo__collections__simulation_unit_test_set__SimulationUnitTestSet__UserInfo
object
2 properties 2 required
amigo_lib__mongo__collections__simulation_unit_test_set_run__SimulationUnitTestSetRun__UnitTestRunResult__MetricEvaluationResult
object
3 properties 3 required
src__app__endpoints__simulation__get_simulation_scenarios__Response
object
4 properties 4 required
src__app__endpoints__simulation__create_simulation_unit_test__Response
object
1 property 1 required
CategoricalMetricSuccessCriterion-Input
object
2 properties 2 required
Verb
string
src__app__endpoints__simulation__get_simulation_unit_test_set_run_artifacts__Response
object
2 properties 2 required
amigo_lib__mongo__collections__simulation_unit_test__SimulationUnitTest__UserInfo
object
2 properties 2 required
src__app__endpoints__simulation__create_simulation_unit_test_set__Response
object
1 property 1 required
src__app__endpoints__simulation__update_simulation_unit_test__Request__SuccessCriterion
object
3 properties 3 required
SimulationScenarioInstance
object
8 properties 8 required
src__app__endpoints__simulation__search_simulation_unit_tests__Response
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-simulation-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

This is an independent, third-party profile of Amigo Simulation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.