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

The World API from Amigo — 21 operation(s) for world.

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

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

This API exposes 23 operations across 21 paths, and defines 53 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.

23 operations 21 paths 53 schemas 1 DELETE17 GET1 PATCH3 POST1 PUT

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 World 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 23

Across 21 paths, the API surfaces 23 operations — 1 DELETE, 17 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

World 23
GET
/v1/{workspace_id}/world/dashboard
World model dashboard composite
world-dashboard 1 param → 200
GET
/v1/{workspace_id}/world/entity-types
List entity types
list-entity-types 1 param → 200401
GET
/v1/{workspace_id}/world/event-types
List event types
list-event-types 1 param → 200401
GET
/v1/{workspace_id}/world/entity-stats
Entity stats with sync breakdown
entity-stats 2 params → 200401422
GET
/v1/{workspace_id}/world/connectors
Connected data sources overview
connector-overview 1 param → 200
GET
/v1/{workspace_id}/world/connectors/{data_source_id}/entities
List entities from a data source
connector-entities 7 params → 200400422
GET
/v1/{workspace_id}/world/connectors/{data_source_id}/resources
Search FHIR resources from a data source
connector-resources 5 params → 200400422
GET
/v1/{workspace_id}/world/source-breakdown
Entity counts by source system
source-breakdown 2 params → 200422
GET
/v1/{workspace_id}/world/sync/by-sink
Outbound sync status per data source
outbound-sync-by-sink 1 param → 200
PUT
/v1/{workspace_id}/world/entities/{entity_id}/enrichment/{key}
Set an enrichment value on an entity
put-entity-enrichment 3 params body → 200400404403422
GET
/v1/{workspace_id}/world/entities/{entity_id}/enrichment
List current enrichment values for an entity
list-entity-enrichment 4 params → 200404422
GET
/v1/{workspace_id}/world/entities/{entity_id}/enrichment/{key}/history
Enrichment supersedes chain for audit
get-entity-enrichment-history 4 params → 200404422
POST
/v1/{workspace_id}/world/migration/conversations
Bulk-import v1 conversation envelopes for migrated patients
bulk-import-migration-conversations 1 param body → 200400403422
POST
/v1/{workspace_id}/world/enrichment-keys
Register an enrichment key
create-enrichment-key 1 param body → 201400409403422
GET
/v1/{workspace_id}/world/enrichment-keys
List enrichment keys registered for this workspace
list-enrichment-keys 4 params → 200422
PATCH
/v1/{workspace_id}/world/enrichment-keys/{key_id}
Update a registered enrichment key
patch-enrichment-key 2 params body → 200404403422
DELETE
/v1/{workspace_id}/world/enrichment-keys/{key_id}
Delete a registered enrichment key
delete-enrichment-key 2 params → 204404403422
GET
/v1/{workspace_id}/world/entities
List entities
list-entities 10 params → 200401422
POST
/v1/{workspace_id}/world/entities/resolve
Resolve entity by identifier
resolve-entity 1 param body → 200400401422
GET
/v1/{workspace_id}/world/entities/{entity_id}
Get entity
get-entity 2 params → 200400404401422
GET
/v1/{workspace_id}/world/entities/{entity_id}/timeline
Entity timeline
get-entity-timeline 5 params → 200400404401422
GET
/v1/{workspace_id}/world/entities/{entity_id}/relationships
Entity relationships
get-entity-relationships 3 params → 200400404401422
GET
/v1/{workspace_id}/world/entities/{entity_id}/merged
Get merged entities (sameas links)
merged-entities 2 params → 200400404422

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are EntityResponse (32 properties), EntityEventResponse (29 properties), EnrichmentKeyResponse (13 properties), ConnectorOverviewItem (12 properties). Each schema is shown below with its type and property counts.

EnrichmentValueResponse
object
9 properties 6 required
EntityTimelineResponse
object
5 properties 4 required
EntityStatsSummary
object
7 properties 5 required
ConnectorOverviewResponse
object
2 properties 2 required
EntityTypeSummary
object
4 properties 4 required
DescriptionString
string
EnrichmentHistoryResponse
object
4 properties 3 required
EventTypeRegistryResponse
object
2 properties 2 required
ExternalSystemString
string
EntityListResponse
object
4 properties 3 required
EntityRelationshipsResponse
object
3 properties 3 required
EventTypeSummary
object
4 properties 4 required
MergedEntitiesResponse
object
3 properties 3 required
PhoneE164
string
MigrationConversationsBody
object
1 property 1 required
OutboundSyncBySinkResponse
object
1 property 1 required
WorldDashboardResponse
object
7 properties 1 required
EntityResponse
object
32 properties 3 required
EnrichmentKeyPatchBody
object
6 properties
EntityResolveMatch
object
One candidate match with provenance + confidence.
5 properties 4 required
EntityTypeRegistryResponse
object
2 properties 2 required
ChannelKind
string
HSM execution channel type. Determines how the HSM engine communicates with end users. Each kind maps to one or more providers.
MigrationConversationItem
object
6 properties 4 required
ConnectorOverviewItem
object
12 properties 5 required
EntityResolveResponse
object
2 properties 1 required
EventCallSidString
string
EnrichmentKeyListResponse
object
1 property 1 required
ExternalValueString
string
ConnectorResourcesResponse
object
FHIR resources from a specific connected data source.
4 properties 4 required
EventDisplayNameString
string
EnrichmentWriteBody
object
6 properties 1 required
HTTPValidationError
object
1 property
SinkSyncStatus
object
7 properties 7 required
ValidationError
object
5 properties 3 required
EventOutcomeString
string
EntityResolveExternalId
object
Reference to an external-system identifier. system labels which system minted the value (epic, charm, charmhealth, …). Resolution probes the canonical entity m…
2 properties 2 required
EntityEventResponse
object
29 properties 3 required
EventChannelString
string
EntityResolveSummary
object
Compact identity card returned for each match. Excludes full entity state — fetch via GET /v1/{ws}/entities/{entityid} if needed. The fields here are the ones…
11 properties
SourceBreakdownResponse
object
2 properties 2 required
EnrichmentHistoryEntry
object
10 properties 7 required
EventDescriptionString
string
EnrichmentKeyResponse
object
13 properties 9 required
EntityRelationshipResponse
object
11 properties 6 required
EnrichmentListResponse
object
2 properties 2 required
CanonicalIdLookupString
string
MigrationConversationsResponse
object
3 properties 3 required
EventStatusString
string
EventDirectionString
string
EntityResolveRequest
object
Polymorphic identifier query. Provide entitytype plus any subset of identifier fields. Each identifier is OR-ed in SQL; matches are ranked by confidence and by…
7 properties 1 required
EnrichmentKeyCreateBody
object
9 properties 3 required
SourceBreakdownItem
object
3 properties 3 required
EntityTypeString
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-world-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 World 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.