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 Simulations API

The Simulations API from Amigo — 33 operation(s) for simulations.

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

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

This API exposes 42 operations across 33 paths, and defines 69 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.

42 operations 33 paths 69 schemas 4 DELETE17 GET2 PATCH19 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 Simulations 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 42

Across 33 paths, the API surfaces 42 operations — 4 DELETE, 17 GET, 2 PATCH, 19 POST. Each is listed below with its method, path, parameters, and response codes.

Simulations 42
POST
/v1/{workspace_id}/simulations/runs
Create Simulation Run
create-simulation-run 1 param body → 200422
GET
/v1/{workspace_id}/simulations/runs
List Simulation Runs
list-simulation-runs 3 params → 200422
GET
/v1/{workspace_id}/simulations/runs/summary
Get Simulation Runs Summary
get-simulation-runs-summary 2 params → 200422
GET
/v1/{workspace_id}/simulations/suites
List Simulation Suites
list-simulation-suites 1 param → 200
POST
/v1/{workspace_id}/simulations/suites
Create Simulation Suite
create-simulation-suite 1 param body → 200422
GET
/v1/{workspace_id}/simulations/suites/{suite_id}
Get Simulation Suite
get-simulation-suite 2 params → 200422
PATCH
/v1/{workspace_id}/simulations/suites/{suite_id}
Update Simulation Suite
update-simulation-suite 2 params body → 200422
DELETE
/v1/{workspace_id}/simulations/suites/{suite_id}
Delete Simulation Suite
delete-simulation-suite 2 params → 204422
GET
/v1/{workspace_id}/simulations/suites/{suite_id}/runs
List Simulation Suite Runs
list-simulation-suite-runs 3 params → 200422
GET
/v1/{workspace_id}/simulations/cases
List Simulation Cases
list-simulation-cases 5 params → 200422
POST
/v1/{workspace_id}/simulations/cases
Create Simulation Cases
create-simulation-cases 1 param body → 200422
GET
/v1/{workspace_id}/simulations/cases/{case_id}
Get Simulation Case
get-simulation-case 2 params → 200404422
PATCH
/v1/{workspace_id}/simulations/cases/{case_id}
Update Simulation Case
update-simulation-case 2 params body → 200404422
DELETE
/v1/{workspace_id}/simulations/cases/{case_id}
Delete Simulation Case
delete-simulation-case 2 params → 204404422
GET
/v1/{workspace_id}/simulations/runs/{run_id}
Get Simulation Run
get-simulation-run 2 params → 200422
GET
/v1/{workspace_id}/simulations/performance
Get Simulation Performance
get-simulation-performance 3 params → 200422
POST
/v1/{workspace_id}/simulations/runs/{run_id}/complete
Complete Simulation Run
complete-simulation-run 3 params → 200422
POST
/v1/{workspace_id}/simulations/sessions/{session_id}/promote
Promote Simulation Session
promote-simulation-session 2 params → 200422
POST
/v1/{workspace_id}/simulations/runs/{run_id}/sessions
Create Simulation Session
create-simulation-session 2 params body → 200422
POST
/v1/{workspace_id}/simulations/sessions/{session_id}/step
Simulation Step
simulation-step 2 params body → 200422
POST
/v1/{workspace_id}/simulations/sessions/{session_id}/fork
Simulation Fork
simulation-fork 2 params body → 200422
POST
/v1/{workspace_id}/simulations/sessions/{session_id}/score
Score Simulation Session
score-simulation-session 2 params body → 200422
POST
/v1/{workspace_id}/simulations/sessions
Create Test Conversation
create-test-conversation 1 param body → 200422
POST
/v1/{workspace_id}/simulations/sessions/step
Test Conversation Step
test-conversation-step 1 param body → 200422
POST
/v1/{workspace_id}/simulations/sessions/recommend
Simulation Recommend
simulation-recommend 1 param body → 200422
GET
/v1/{workspace_id}/simulations/sessions/{session_id}
Simulation Observe
simulation-observe 2 params → 200422
DELETE
/v1/{workspace_id}/simulations/sessions/{session_id}
Simulation Destroy
simulation-destroy 2 params → 200422
GET
/v1/{workspace_id}/simulations/sessions/{session_id}/intelligence
Simulation Intelligence
simulation-intelligence 2 params → 200422
GET
/v1/{workspace_id}/simulations/services/{service_id}/graph
Get Simulation Coverage Graph
get-simulation-coverage-graph 4 params → 200422
DELETE
/v1/{workspace_id}/simulations/services/{service_id}/graph
Delete Simulation Coverage Graph
delete-simulation-coverage-graph 2 params → 200422
GET
/v1/{workspace_id}/simulations/services/{service_id}/graph/paths
Get Simulation Coverage Paths
get-simulation-coverage-paths 3 params → 200422
GET
/v1/{workspace_id}/simulations/services/{service_id}/sessions
List Simulation Sessions
list-simulation-sessions 4 params → 200422
GET
/v1/{workspace_id}/simulations/sessions/{session_id}/turns
Get Simulation Session Turns
get-simulation-session-turns 2 params → 200422
GET
/v1/{workspace_id}/simulations/services/{service_id}/turns
Query Simulation Turns
query-simulation-turns 6 params → 200422
POST
/v1/{workspace_id}/simulations/config-to-policy
Config To Turn Policy
config-to-turn-policy 1 param body → 200422
POST
/v1/{workspace_id}/simulations/bridge
Simulation Bridge
simulation-bridge 1 param body → 200422
POST
/v1/{workspace_id}/simulations/benchmarks/run
Run Simulation Benchmark
run-simulation-benchmark 1 param body → 200422
POST
/v1/{workspace_id}/simulations/suites/{suite_id}/run
Run Simulation Suite
run-simulation-suite 2 params body → 200422
POST
/v1/{workspace_id}/simulations/benchmarks/results
Get Simulation Benchmark Results
get-simulation-benchmark-results 1 param body → 200422
GET
/v1/{workspace_id}/simulations/suite-runs/{suite_run_id}
Get Simulation Suite Run Results
get-simulation-suite-run-results 2 params → 200422
POST
/v1/{workspace_id}/simulations/cases/{case_id}/run
Run Simulation Case
run-simulation-case 2 params body → 200422
POST
/v1/{workspace_id}/simulations/bridge/plan
Simulation Bridge Plan
simulation-bridge-plan 1 param body → 200422

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are SimulationBenchmarkPerRunSummary (27 properties), SimulationRunResponse (24 properties), SimulationEvalResultResponse (19 properties), EvaluationResultView (18 properties). Each schema is shown below with its type and property counts.

SimulationSuiteRunResultsResponse
object
18 properties 4 required
CreateRunRequest
object
3 properties 1 required
BridgeResponse
object
6 properties 3 required
SimulationIntelligenceResponse
object
2 properties 2 required
SimCasePerfResponse
object
8 properties 2 required
SimulationBenchmarkRunResponse
object
9 properties 8 required
SimulationCaseAssertionEval
object
7 properties 3 required
TargetSpec
object
4 properties
SimulationBenchmarkBreakdownSummary
object
8 properties
ForkAlternative
object
3 properties 1 required
RunSimulationCaseRequest
object
7 properties
SimulationSnapshotResponse
object
11 properties 1 required
SimMetricPerfResponse
object
3 properties 2 required
SimMetricRunPointResponse
object
One run's contribution to a metric: the mean value that run (null for non-numeric metrics) plus how many conversations passed / were measured.
4 properties
PaginatedResponse_SimulationCaseResponse_
object
4 properties 2 required
SimulationRunSummaryResponse
object
Aggregate counts across a workspace's simulation runs, for the Runs page summary strip. A cheap GROUP BY status over world.simulationcoverageruns — honest tota…
8 properties 7 required
ToolCallDetail
object
Rich tool call data from a simulation step.
5 properties 1 required
UpdateSimulationSuiteRequest
object
6 properties
SimulationPerformanceResponse
object
Aggregated Simulations overview: one request in place of the console's former one-detail-fetch-per-run fan-out.
4 properties 1 required
SimPerformanceOverviewResponse
object
4 properties
SimulationCaseScenario
object
Runnable patient-side scenario content for a saved case.
3 properties 1 required
RunSimulationBenchmarkRequest
object
10 properties
PromoteSessionResponse
object
Result of binding a run-less session to a (newly created) coverage run.
3 properties 3 required
SimulationCaseMetricEval
object
5 properties 2 required
SimCaseAssertionResponse
object
8 properties 3 required
SimulationCaseGrounding
object
Optional bindings that start the sim from existing workspace data.
1 property
SimulationSuiteResponse
object
HTTP response shape for first-class simulation suites.
12 properties 4 required
DestroySessionResponse
object
1 property 1 required
ListSimulationSuiteRunsResponse
object
2 properties 2 required
Scenario
object
6 properties 3 required
SimulationObservation
object
12 properties 5 required
ForkRequest
object
1 property 1 required
CreateSessionRequest
object
5 properties 1 required
CreateSimulationSuiteRequest
object
6 properties 1 required
OrderedPathway
object
2 properties 2 required
SimulationCaseResponse
object
HTTP response shape for durable simulation cases.
13 properties 4 required
StepRequest
object
4 properties 2 required
SimulationSessionResponse
object
4 properties 4 required
SimulationStepResponse
object
2 properties 2 required
HTTPValidationError
object
1 property
BridgeRequest
object
12 properties 2 required
ListSimulationSuitesResponse
object
1 property 1 required
UpdateSimulationCaseRequest
object
Partial update for one durable simulation case. Mirrors the nested CreateSimulationCaseItem shape with every field optional so modeldump(excludeunset=True) onl…
8 properties
CreateSimulationCaseItem
object
One durable simulation case to create.
8 properties 2 required
SimulationBenchmarkPerRunSummary
object
27 properties 3 required
ValidationError
object
5 properties 3 required
CompletionCriteria
object
2 properties
SimulationSuiteRunSummary
object
14 properties 4 required
CreateSimulationCasesResponse
object
1 property 1 required
RecommendRequest
object
2 properties 1 required
SimulationBenchmarkResultsResponse
object
15 properties 2 required
ScenarioPersona
object
5 properties
SimSuitePerfResponse
object
7 properties 1 required
RecommendResponse
object
1 property 1 required
NonDesiredState
object
2 properties 1 required
SimulationStateResponse
object
9 properties 2 required
SimulationEvalResultResponse
object
19 properties 3 required
SimulationBenchmarkCaseResult
object
6 properties 2 required
CreateSimulationCasesRequest
object
1 property 1 required
ConfigToPolicyRequest
object
1 property 1 required
SimulationRunResponse
object
Full run payload — used by GET /runs/{runid} for replay flows.
24 properties 4 required
GetSimulationBenchmarkResultsRequest
object
1 property 1 required
SimulationBenchmarkAggregateSummary
object
7 properties 4 required
EvaluationResultView
object
One check as the console renders it, derived from a single eval result. Both metric and assertion verdicts normalize to this shape so the frontend renders a ch…
18 properties 3 required
ScoreSessionRequest
object
2 properties 1 required
SimulationTurnPolicyResponse
object
6 properties
BridgePlanRequest
object
2 properties 2 required
ExplorationConfig
object
4 properties
BridgePlanResponse
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-simulations-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 Simulations 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.