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

The Events API from Amigo — 1 operation(s) for events.

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

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

This API exposes 1 operation across 1 path, and defines 51 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.

1 operations 1 paths 51 schemas 1 GET

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 Events 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Events 1
GET
/v1/{workspace_id}/events/stream
Event Stream
get-event-stream 1 param → 200429

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are TextBackgroundResultEvent (8 properties), SurfaceCreatedEvent (8 properties), SurfaceDeliveredEvent (8 properties), SimulationTurnStoredEvent (8 properties). Each schema is shown below with its type and property counts.

OperatorLeftCallEvent
object
4 properties 2 required
OperatorWrapUpEvent
object
3 properties 1 required
ChannelEmailBouncedEvent
object
6 properties 3 required
ChannelEmailRejectedEvent
object
4 properties 3 required
SurfaceReshapedEvent
object
3 properties 2 required
SurfaceSubmittedEvent
object
5 properties 2 required
TextBackgroundResultEvent
object
A background (execution="background") tool finished for a web text conversation. Pushed live the instant the completion lands so a subscribed client renders th…
8 properties 6 required
SurfaceFieldSavedEvent
object
4 properties 3 required
ReviewSubmittedEvent
object
6 properties 1 required
WorkspaceInvitationSentEvent
object
4 properties 2 required
ChannelEmailDelayedEvent
object
4 properties 3 required
CallStartedEvent
object
5 properties 3 required
SurfaceReviewRejectedEvent
object
3 properties 1 required
SimulationTurnStoredEvent
object
8 properties 7 required
ChannelVoicemailStatusEvent
object
Ringless voicemail status callback projected from VoiceDrop. status mirrors the channel.voicedropringlessvoicemails enum: delivered, skipped, failed, or notdel…
4 properties 3 required
SurfaceDeliveredEvent
object
8 properties 3 required
TextAgentMessageEvent
object
An agent text turn pushed live over workspace SSE — the outbox of the durable text-conversation actor (text-conversation-actor Stage A). Where TextBackgroundRe…
4 properties 2 required
WorkspaceMemberRoleUpdatedEvent
object
4 properties 3 required
SurfaceCreatedEvent
object
8 properties 2 required
WorkspaceSSEEvent
ChannelEmailOpenedEvent
object
3 properties 2 required
SurfacePendingReviewEvent
object
6 properties 2 required
TextToolStartedEvent
object
A slow text tool began running for a web text conversation — pushed live the instant the tool is dispatched, before the 15s blocking floor elapses, so a subscr…
5 properties 4 required
OperatorProfileUpdatedEvent
object
3 properties 1 required
SurfaceReviewApprovedEvent
object
2 properties 1 required
PipelineSyncCompletedEvent
object
4 properties 3 required
OperatorRegisteredEvent
object
3 properties 1 required
OperatorJoinedCallEvent
object
4 properties 3 required
EncounterUpdatedEvent
object
3 properties 2 required
TriggerCompletedEvent
object
4 properties 3 required
ChannelEmailClickedEvent
object
3 properties 2 required
TextCompletedEvent
object
7 properties 5 required
OperatorStatusChangedEvent
object
3 properties 2 required
IntegrationApprovalRejectedEvent
object
3 properties 1 required
ChannelEmailComplainedEvent
object
4 properties 3 required
TriggerFailedEvent
object
4 properties 3 required
WorkspaceMemberAddedEvent
object
3 properties 2 required
IntegrationApprovalGrantedEvent
object
2 properties 1 required
ChannelEmailReceivedEvent
object
Inbound email persisted to channel.inboundemails as a reply to one of our outbound sends. inreplytoemailid is the outbound row this inbound threads against.
6 properties 5 required
CallEscalatedEvent
object
5 properties 4 required
SurfaceOpenedEvent
object
3 properties 2 required
SurfaceUpdatedEvent
object
2 properties 1 required
SurfaceArchivedEvent
object
2 properties 1 required
ChannelEmailDeliveredEvent
object
4 properties 3 required
OperatorModeChangedEvent
object
4 properties 3 required
PipelineErrorEvent
object
3 properties 2 required
CallEndedEvent
object
6 properties 4 required
TriggerFiredEvent
object
4 properties 2 required
NarrativeUpdatedEvent
object
7 properties 6 required
TextStartedEvent
object
5 properties 3 required
WorkspaceInvitationAcceptedEvent
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-events-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 Events 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.