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

The Services API from Amigo — 5 operation(s) for services.

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

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

This API exposes 8 operations across 5 paths, and defines 23 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 5 paths 23 schemas 1 DELETE2 GET3 POST2 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 Services 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 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Services 8
POST
/v1/{workspace_id}/services
Create a service
create-service 1 param body → 201404409403401422
GET
/v1/{workspace_id}/services
List services
list-services 6 params → 200404403401422
GET
/v1/{workspace_id}/services/{service_id}
Get a service
get-service 2 params → 200404403401422
PUT
/v1/{workspace_id}/services/{service_id}
Update a service
update-service 2 params body → 200404409403401422
DELETE
/v1/{workspace_id}/services/{service_id}
Delete a service
delete-service 2 params → 204404403401422
PUT
/v1/{workspace_id}/services/{service_id}/version-sets/{name}
Upsert a service version set
upsert-service-version-set 3 params body → 204404409403401422
POST
/v1/{workspace_id}/services/{service_id}/voice-turn
Voice Turn
voice-turn 2 params body → 200204409422
POST
/v1/{workspace_id}/services/{service_id}/text-turn
Text Turn
text-turn 2 params body → 200204409422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ServiceVoiceConfig-Output (25 properties), ServiceVoiceConfig-Input (25 properties), ServiceResponse (19 properties), LLMExperienceControls (19 properties). Each schema is shown below with its type and property counts.

VersionSet-Input
object
Pins agent, state machine, and LLM model versions for a service.
4 properties
DescriptionString
string
UpdateServiceRequest
object
12 properties
PaginatedResponse_ServiceResponse_
object
4 properties 2 required
PhoneE164
string
ServiceResponse
object
19 properties 13 required
LLMConfig
object
3 properties 1 required
TextTurnRequest
object
Request body for POST /v1/{ws}/services/{serviceid}/text-turn.
3 properties 3 required
VersionSet-Output
object
Pins agent, state machine, and LLM model versions for a service.
4 properties
NameString
string
CreateServiceRequest
object
12 properties 3 required
ServiceVoiceConfig-Output
object
Per-service voice pipeline tuning. Overrides workspace/env defaults. Each field is optional — None means inherit from the layer above (workspace VoiceSettings…
25 properties
LanguageProviderEntry
object
Per-language TTS provider configuration.
2 properties 1 required
UpsertVersionSetRequest
object
1 property 1 required
Body_voice-turn
object
2 properties 2 required
ServiceVoiceConfig-Input
object
Per-service voice pipeline tuning. Overrides workspace/env defaults. Each field is optional — None means inherit from the layer above (workspace VoiceSettings…
25 properties
HTTPValidationError
object
1 property
SearchString
string
ValidationError
object
5 properties 3 required
ServiceForwardingConfig
object
Per-service call-forwarding destination + transfer mechanism. Read by the LLM-driven forwardcall tool (tier 3 fallback when the LLM doesn't pass an explicit ph…
3 properties 1 required
TextTurnResponse
object
Response body — the agent's text reply. Returned only on 200; 204 indicates the engine elected silence.
1 property 1 required
ServiceTag
object
2 properties 1 required
LLMExperienceControls
object
First-class chat experience controls for consumer-facing agents. params remains available as a provider-specific escape hatch. These fields cover the OpenAI Ch…
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-services-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 Services 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.