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

The Runs API from Amigo — 10 operation(s) for runs.

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

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

This API exposes 10 operations across 10 paths, and defines 20 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.

10 operations 10 paths 20 schemas 4 GET6 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 Runs 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 10

Across 10 paths, the API surfaces 10 operations — 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Runs 10
GET
/v1/{workspace_id}/runs
List runs (framework + conversation)
list_runs_v1__workspace_id__runs_get 7 params → 200422
GET
/v1/{workspace_id}/runs/summary
Run counts (framework + conversation)
runs_summary_v1__workspace_id__runs_summary_get 3 params → 200422
GET
/v1/{workspace_id}/runs/{run_id}
Get one run (framework or conversation) by runid
get_run_v1__workspace_id__runs__run_id__get 2 params → 200422
GET
/v1/{workspace_id}/runs/{run_id}/trajectory
Get a framework run's step-by-step trajectory
get_run_trajectory_v1__workspace_id__runs__run_id__trajectory_get 2 params → 200422
POST
/v1/{workspace_id}/runs/{run_id}/guidance
Send operator guidance to a live run
send_run_guidance_v1__workspace_id__runs__run_id__guidance_post 2 params body → 200422
POST
/v1/{workspace_id}/runs/{run_id}/takeover
Take over a live run as operator
take_over_run_v1__workspace_id__runs__run_id__takeover_post 2 params body → 200422
POST
/v1/{workspace_id}/runs/{run_id}/handback
Hand a taken-over run back to the agent
hand_back_run_v1__workspace_id__runs__run_id__handback_post 2 params body → 200422
POST
/v1/{workspace_id}/runs/{run_id}/authored-turn
Author the next turn on a non-voice run under takeover
author_run_turn_v1__workspace_id__runs__run_id__authored_turn_post 2 params body → 200422
POST
/v1/{workspace_id}/runs/{run_id}/switch-mode
Switch an operator between listen and takeover on a live run
switch_run_mode_v1__workspace_id__runs__run_id__switch_mode_post 2 params body → 200422
POST
/v1/{workspace_id}/runs/{run_id}/access-token
Mint a browser-audio access token for an operator on a live run
mint_run_access_token_v1__workspace_id__runs__run_id__access_token_post 2 params body → 200422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Run (21 properties), TrajectoryStep (11 properties), RunsSummaryResponse (9 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

RunAuthoredTurnRequest
object
2 properties 2 required
RunTakeoverRequest
object
2 properties 1 required
RunSwitchModeRequest
object
3 properties 3 required
RunAuthoredTurnResponse
object
2 properties 2 required
RunsSummaryResponse
object
Aggregate run counts for the Runs page summary strip. Honest workspace totals the paginated list cannot derive client-side (it only holds the loaded page). bys…
9 properties 9 required
TakeoverEligibility
object
Whether an operator can take a run over, and how — the channel-neutral signal the console keys on instead of a per-channel heuristic. eligible = an operator ma…
3 properties 1 required
RunHandbackResponse
object
2 properties 2 required
RunHandbackRequest
object
1 property 1 required
RunGuidanceRequest
object
Operator guidance for a live run. operatorid is in the body because this router is not under /operators/{operatorid} — it is bound to the authenticated caller…
2 properties 2 required
HTTPValidationError
object
1 property
RunAccessTokenResponse
object
4 properties 2 required
RunGuidanceResponse
object
2 properties 2 required
RunSwitchModeResponse
object
2 properties 2 required
ValidationError
object
5 properties 3 required
RunsResponse
object
3 properties 2 required
RunTrajectoryResponse
object
2 properties 2 required
Run
object
The universal agent-run object. runid is a dedicated UUID (not an overloaded callsid / conversationid); the originating subsystem's ids are kept as source prov…
21 properties 6 required
TrajectoryStep
object
One structural step of a framework run's trajectory. Fields are best-effort (only those the step actually carries are present), all optional, and free str for…
11 properties
RunTakeoverResponse
object
4 properties 2 required
RunAccessTokenRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-runs-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 Runs 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.