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

The Pipeline API from Amigo — 10 operation(s) for pipeline.

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

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

This API exposes 10 operations across 10 paths, and defines 18 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 18 schemas 10 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 Pipeline 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 — 10 GET. Each is listed below with its method, path, parameters, and response codes.

Pipeline 10
GET
/v1/{workspace_id}/pipeline/status
Pipeline status
get-pipeline-status 1 param → 200429
GET
/v1/{workspace_id}/pipeline/sources
List pipeline sources
list-pipeline-sources 5 params → 200429422
GET
/v1/{workspace_id}/pipeline/sources/{source_id}/overview
Source overview
get-source-overview 2 params → 200404429422
GET
/v1/{workspace_id}/pipeline/sources/{source_id}/history
Source sync history
get-source-history 6 params → 200429422
GET
/v1/{workspace_id}/pipeline/sources/{source_id}/events
Source events
list-source-events 9 params → 200429422
GET
/v1/{workspace_id}/pipeline/outbound
Outbound sync summary
get-outbound-summary 1 param → 200429
GET
/v1/{workspace_id}/pipeline/outbound/{data_source_id}/log
Outbound sync log
list-outbound-log 6 params → 200429422
GET
/v1/{workspace_id}/pipeline/entity-resolution
Entity resolution metrics
get-entity-resolution 1 param → 200429
GET
/v1/{workspace_id}/pipeline/review
Review pipeline metrics
get-review-metrics 1 param → 200429
GET
/v1/{workspace_id}/pipeline/throughput
Event throughput
get-throughput 6 params → 200429422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are PipelineStatusResponse (15 properties), SourceOverviewResponse (15 properties), SourceStatus (11 properties), SourceListItem (9 properties). Each schema is shown below with its type and property counts.

LastPollInfo
object
4 properties
OutboundSinkSummary
object
7 properties 6 required
ReviewMetrics
object
6 properties 4 required
PaginatedResponse_OutboundLogItem_
object
4 properties 2 required
OutboundSummary
object
5 properties
SourceStatus
object
11 properties 4 required
HTTPValidationError
object
1 property
PipelineStatusResponse
object
15 properties 2 required
OutboundLogItem
object
6 properties 4 required
SourceEventItem
object
8 properties 5 required
ValidationError
object
5 properties 3 required
SourceFailureItem
object
5 properties 2 required
SourceListItem
object
9 properties 5 required
SourceHistoryItem
object
3 properties 2 required
EntityResolutionMetrics
object
4 properties 3 required
PaginatedResponse_SourceEventItem_
object
4 properties 2 required
SourceOverviewResponse
object
15 properties 5 required
ThroughputBucket
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-pipeline-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 Pipeline 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.