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

The Operators API from Amigo — 17 operation(s) for operators.

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

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

This API exposes 19 operations across 17 paths, and defines 40 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.

19 operations 17 paths 40 schemas 10 GET1 PATCH8 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 Operators 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 19

Across 17 paths, the API surfaces 19 operations — 10 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Operators 19
GET
/v1/{workspace_id}/operators/dashboard
Operator dashboard overview
operator-dashboard 1 param → 200
GET
/v1/{workspace_id}/operators/performance
Operator performance summary
operator-performance-summary 1 param → 200
GET
/v1/{workspace_id}/operators/escalations/active
List active escalations
list-active-escalations 3 params → 200422
GET
/v1/{workspace_id}/operators/escalations/stats
Escalation statistics
escalation-stats 3 params → 200422
GET
/v1/{workspace_id}/operators/escalations
List escalation events
list-escalations 3 params → 200422
GET
/v1/{workspace_id}/operators/audit-log
Query audit log
list-audit-log 5 params → 200422
GET
/v1/{workspace_id}/operators/calls/{call_sid}/transcript
Get call transcript
get-call-transcript 2 params → 200404422
GET
/v1/{workspace_id}/operators/queue
Priority-ranked operator queue
get-operator-queue 1 param → 200429
POST
/v1/{workspace_id}/operators/{operator_id}/briefing
Generate operator briefing
create-operator-briefing 2 params body → 200400429422
POST
/v1/{workspace_id}/operators/{operator_id}/join-call
Join active call as operator
operator-join-call 2 params body → 200404409503422
POST
/v1/{workspace_id}/operators/{operator_id}/leave-call
Remove operator from active call
operator-leave-call 2 params body → 200404503422
POST
/v1/{workspace_id}/operators/{operator_id}/access-token
Generate browser audio access token
operator-access-token 2 params body → 200404503422
POST
/v1/{workspace_id}/operators/{operator_id}/switch-mode
Toggle operator listen/takeover mode
operator-switch-mode 2 params body → 200404503422
POST
/v1/{workspace_id}/operators/{operator_id}/send-guidance
Send text guidance to agent during call
operator-send-guidance 2 params body → 200404503422
POST
/v1/{workspace_id}/operators/{operator_id}/wrap-up
Record operator intervention wrap-up
operator-wrap-up 2 params body → 200404422
POST
/v1/{workspace_id}/operators
Register an operator
create-operator 1 param body → 201401403422
GET
/v1/{workspace_id}/operators
List operators
list-operators 3 params → 200422
GET
/v1/{workspace_id}/operators/{operator_id}
Get an operator
get-operator 2 params → 200404422
PATCH
/v1/{workspace_id}/operators/{operator_id}
Update an operator
update-operator 2 params body → 200404422

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are PriorityQueueItem (20 properties), ActiveEscalationItem (19 properties), OperatorResponse (17 properties), PerformanceSummaryResponse (8 properties). Each schema is shown below with its type and property counts.

TranscriptSegment
object
5 properties 5 required
SwitchModeResponse
object
1 property 1 required
PaginatedResponse_EscalationEventResponse_
object
4 properties 2 required
EscalationStatsBucket
object
2 properties 2 required
PaginatedResponse_OperatorResponse_
object
4 properties 2 required
AccessTokenResponse
object
4 properties 3 required
WrapUpResponse
object
1 property 1 required
EscalationEventResponse
object
8 properties 6 required
PhoneE164
string
OperatorStatusCounts
object
4 properties 4 required
OperatorResponse
object
17 properties 8 required
PerformanceSummaryResponse
object
8 properties 8 required
DashboardResponse
object
5 properties 5 required
BriefingRequest
object
Request for operator briefing on a specific call.
1 property 1 required
EscalationDailyStats
object
5 properties
AccessTokenRequest
object
Request to generate a Twilio AccessToken for browser-based audio.
1 property 1 required
PaginatedResponse_AuditEventResponse_
object
4 properties 2 required
CreateOperatorRequest
object
7 properties 2 required
NameString
string
src__routes__operators_models__AuditEventResponse
object
7 properties 5 required
PriorityQueueItem
object
An active call ranked by operator priority.
20 properties 2 required
LeaveCallRequest
object
Request to remove operator from an active call.
1 property 1 required
BriefingResponse
object
Structured operator briefing for a call.
4 properties 4 required
WrapUpRequest
object
Request to record operator intervention wrap-up.
3 properties 2 required
JoinCallResponse
object
Confirmation of operator joining a call's conference.
4 properties 4 required
EscalationStatsResponse
object
5 properties 5 required
JoinCallRequest
object
Request to join an active call as operator.
2 properties 1 required
SendGuidanceRequest
object
2 properties 2 required
HTTPValidationError
object
1 property
UpdateOperatorRequest
object
8 properties
ActiveEscalationItem
object
A call with an active escalation, enriched from projected state.
19 properties 3 required
ValidationError
object
5 properties 3 required
OperatorPerformanceItem
object
6 properties 4 required
SendGuidanceResponse
object
2 properties 2 required
SwitchModeRequest
object
Request to toggle operator mode on an active call.
3 properties 2 required
CallTranscriptResponse
object
4 properties 4 required
BriefingSection
object
A named section of the operator briefing.
2 properties 2 required
PaginatedResponse_ActiveEscalationItem_
object
4 properties 2 required
PriorityQueueResponse
object
3 properties 3 required
LeaveCallResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-operators-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 Operators 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.