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

The Integrations API from Amigo — 7 operation(s) for integrations.

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

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

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

13 operations 7 paths 26 schemas 2 DELETE4 GET2 PATCH5 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 Integrations 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 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 4 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Integrations 13
POST
/v1/{workspace_id}/integrations
Create a REST integration
create-integration 1 param body → 201404409403401422
GET
/v1/{workspace_id}/integrations
List integrations
list-integrations 6 params → 200403401422
POST
/v1/{workspace_id}/integrations/approvals/{conversation_id}/approve
Approve a pending integration-write approval
approve-integration-write 2 params → 200404403401429422
POST
/v1/{workspace_id}/integrations/approvals/{conversation_id}/reject
Reject a pending integration-write approval
reject-integration-write 2 params body → 200404403401429422
GET
/v1/{workspace_id}/integrations/{integration_id}
Get an integration
get-integration 2 params → 200404403401422
PATCH
/v1/{workspace_id}/integrations/{integration_id}
Update a REST integration
update-integration 2 params body → 200404409403401422
DELETE
/v1/{workspace_id}/integrations/{integration_id}
Delete a REST integration
delete-integration 2 params → 204404409403401422
POST
/v1/{workspace_id}/integrations/{integration_id}/endpoints
Add an endpoint
create-integration-endpoint 2 params body → 201404409403401422
GET
/v1/{workspace_id}/integrations/{integration_id}/endpoints
List endpoints
list-integration-endpoints 6 params → 200403401422
GET
/v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_id}
Get an endpoint
get-integration-endpoint 3 params → 200404403401422
PATCH
/v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_id}
Update an endpoint
update-integration-endpoint 3 params body → 200404409403401422
DELETE
/v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_id}
Delete an endpoint
delete-integration-endpoint 3 params → 204404409403401422
POST
/v1/{workspace_id}/integrations/{integration_id}/endpoints/{endpoint_id}/test
Test an integration endpoint
test-integration-endpoint 3 params body → 200404403401422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are EndpointResponse (14 properties), src__routes__integrations__create_endpoint__Request (13 properties), RestIntegrationResponse (13 properties), OAuth2JwtBearerAuthRequest (12 properties). Each schema is shown below with its type and property counts.

IntegrationRejectRequest
object
Reject body — optional free-text reason surfaced to the agent.
1 property
src__routes__integrations__test_endpoint__Response
object
Full breadcrumb returned by the test handler.
7 properties
src__routes__integrations__update_endpoint__Request
object
Patch an existing endpoint (V186 flat shape). name is immutable.
12 properties
OAuth2JwtBearerAuthDict
object
OAuth 2.0 JWT Bearer Token — RFC 7523. assertionusage selects the flow: § 2.1 (JWT as authorization grant) or § 2.2 (JWT as client authentication / privatekeyj…
12 properties 12 required
src__routes__integrations__create_integration__Request
object
Create body — REST only.
8 properties 3 required
NameString
string
EndpointResponse
object
Per-endpoint response (V186 flat shape).
14 properties 5 required
OAuth2JwtBearerAuthRequest
object
OAuth 2.0 JWT Bearer Token — RFC 7523. assertionusage (required) selects the flow: § 2.1 (JWT as authorization grant) or § 2.2 (JWT as client authentication /…
12 properties 5 required
IntegrationApprovalResponse
object
Resolution outcome for a pending integration-write approval.
2 properties 2 required
ParamValueDict
object
Routing target for one per-request parameter on the exchange call. Paired with a wire-name (header / body-field key) on CustomTokenExchangeAuthDict.paramheader…
2 properties 2 required
src__routes__integrations__list_integrations__Response
object
3 properties 2 required
src__routes__integrations__list_endpoints__Response
object
3 properties 2 required
RestIntegrationResponse
object
REST variant — base URL, auth config, endpoint count.
13 properties 9 required
ParamValueRequest
object
Routing target for a single per-request parameter on the exchange call. Paired with a wire-name (header / body-field key) on CustomTokenExchangeAuthRequest.par…
2 properties 2 required
HTTPValidationError
object
1 property
SearchString
string
ValidationError
object
5 properties 3 required
OAuth2ClientCredentialsAuthDict
object
OAuth 2.0 Client Credentials Grant — RFC 6749 § 4.4.
5 properties 5 required
src__routes__integrations__update_integration__Request
object
PATCH body — each field is sentinel-defaulted; absent ≠ explicit-null.
7 properties
src__routes__integrations__create_endpoint__Request
object
Add a new endpoint to a REST integration (V186 flat shape).
13 properties 3 required
CustomTokenExchangeAuthRequest
object
Pre-flight exchange that mints a downstream bearer. Replaces legacy jsontokenexchange AND bearertokenexchange. Path-shaped fields (responsetokenpath, staticbod…
10 properties 2 required
src__routes__integrations__test_endpoint__Request
object
Inputs to POST /{integrationid}/endpoints/{endpointid}/test.
2 properties
CustomTokenExchangeAuthDict
object
Pre-flight exchange that mints a downstream bearer. Replaces legacy jsontokenexchange AND bearertokenexchange. Downstream call always receives Authorization: B…
10 properties 9 required
StaticHeaderAuthRequest
object
Static workspace-level secret used verbatim as a single header value.
2 properties 1 required
OAuth2ClientCredentialsAuthRequest
object
OAuth 2.0 Client Credentials Grant — RFC 6749 § 4.4. Strict RFC 6749 § 4.4.2 access token request: granttype + optional scope. Client authentication (RFC 6749…
5 properties 2 required
StaticHeaderAuthDict
object
Static workspace-level secret used verbatim as a single header value. Replaces legacy apikeyheader and bearertoken — bearer is just headername="Authorization"…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-integrations-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 Integrations 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.