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 Use Cases API

The Use Cases API from Amigo — 4 operation(s) for use cases.

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

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

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

8 operations 4 paths 8 schemas 2 DELETE4 GET2 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 Use Cases 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 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Use Cases 8
GET
/v1/{workspace_id}/use-cases
List channel use cases
list-use-cases 4 params → 200403422
GET
/v1/{workspace_id}/use-cases/ownership
List use cases this workspace owns
list-owned-use-cases 1 param → 200403
PUT
/v1/{workspace_id}/use-cases/{use_case_id}/ownership
Assign ownership of a use case to this workspace
assign-use-case-ownership 2 params → 200404409403422
DELETE
/v1/{workspace_id}/use-cases/{use_case_id}/ownership
Release this workspace's ownership of a use case
release-use-case-ownership 2 params → 204404409403422
GET
/v1/{workspace_id}/use-cases/{use_case_id}/ownership
Check whether this workspace owns a use case
get-use-case-ownership 2 params → 200404403422
PUT
/v1/{workspace_id}/use-cases/{use_case_id}/service-binding
Bind a use case to a platform service
bind-use-case-to-service 2 params body → 200404409422403502504
DELETE
/v1/{workspace_id}/use-cases/{use_case_id}/service-binding
Unbind a use case from its platform service
unbind-use-case-from-service 2 params → 204404403422
GET
/v1/{workspace_id}/use-cases/{use_case_id}/service-binding
Get the service binding for a use case
get-use-case-service-binding 2 params → 200404403422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are UseCaseResponse (14 properties), ServiceBindingResponse (6 properties), ValidationError (5 properties), OwnershipResponse (2 properties). Each schema is shown below with its type and property counts.

ServiceBindingRequest
object
1 property 1 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
ServiceBindingResponse
object
6 properties 6 required
UseCaseResponse
object
14 properties 8 required
UseCaseListResponse
object
1 property 1 required
OwnedUseCasesResponse
object
1 property 1 required
OwnershipResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-use-cases-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 Use Cases 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.