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

The Settings API from Amigo — 9 operation(s) for settings.

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

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

This API exposes 16 operations across 9 paths, and defines 33 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.

16 operations 9 paths 33 schemas 7 GET2 POST7 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 Settings 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 16

Across 9 paths, the API surfaces 16 operations — 7 GET, 2 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 16
GET
/v1/{workspace_id}/settings/retention
Get retention policy
get-retention-policy 1 param → 200429
PUT
/v1/{workspace_id}/settings/retention
Update retention policy
update-retention-policy 1 param body → 200404422429
GET
/v1/{workspace_id}/settings/gap-scanner
Get gap scanner settings
get-gap-scanner-settings 1 param → 200429
PUT
/v1/{workspace_id}/settings/gap-scanner
Update gap scanner settings
update-gap-scanner-settings 1 param body → 200404422429
POST
/v1/{workspace_id}/settings/gap-scanner/preview
Preview gap detection (dry run)
gap-scanner-preview 1 param body → 200429503422
POST
/v1/{workspace_id}/settings/gap-scanner/scan
Trigger one scan tick
gap-scanner-scan 1 param → 200429503
GET
/v1/{workspace_id}/settings/metrics
Get metric definitions
get-metric-settings 1 param → 200429
PUT
/v1/{workspace_id}/settings/metrics
Update metric definitions
update-metric-settings 1 param body → 200404422429
GET
/v1/{workspace_id}/settings/outreach
Get outreach settings
get-outreach-settings 1 param → 200429
PUT
/v1/{workspace_id}/settings/outreach
Update outreach settings
update-outreach-settings 1 param body → 200404422429
GET
/v1/{workspace_id}/settings/branding
Get workspace branding
get-branding-settings 1 param → 200429
PUT
/v1/{workspace_id}/settings/branding
Update workspace branding
update-branding-settings 1 param body → 200404422429
GET
/v1/{workspace_id}/settings/environments
Get environment overrides
get-environment-settings 1 param → 200429
PUT
/v1/{workspace_id}/settings/environments
Update environment overrides
update-environment-settings 1 param body → 200404422429
GET
/v1/{workspace_id}/settings/voice
Get voice settings
get-voice-settings 1 param → 200429
PUT
/v1/{workspace_id}/settings/voice
Update voice settings
update-voice-settings 1 param body → 200404422429

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are MetricDefinition (33 properties), VoiceSettingsRequest (14 properties), VoiceSettingsResponse (14 properties), OutreachRule (12 properties). Each schema is shown below with its type and property counts.

FieldType
string
Input field types for surface data collection.
DataTemplateField
object
A field in a data template — maps to entity state path for gap detection.
6 properties 3 required
QuietHours
object
Quiet hours — no outbound outreach during this window.
4 properties
EnvironmentOverrides
object
Per-environment config overrides merged at runtime.
3 properties
DescriptionString
string
GapScannerPreviewRequest
object
1 property
DataTemplate-Output
object
Named field template — reusable across multiple outreach rules.
3 properties 2 required
BrandingConfig
object
Visual branding for patient-facing surfaces.
4 properties
MetricDefinition
object
A single metric definition — what to extract and how. Two broad modes: - Built-in metrics: extraction is handled by hardcoded pipeline logic (extractpath + agg…
33 properties 5 required
EnvironmentSettingsRequest
object
1 property 1 required
BrandingSettingsRequest
object
Update workspace branding. All fields are optional — only provided fields are changed.
1 property 1 required
MetricSettingsResponse
object
1 property 1 required
VoiceSettingsRequest
object
Voice experience control plane — PM-facing, high-level controls. Controls the caller experience without exposing engineering internals. Emotion detection, fill…
14 properties
NameString
string
LanguageProviderEntry
object
Per-language TTS provider configuration.
2 properties 1 required
RetentionPolicyResponse
object
7 properties 6 required
HTTPValidationError
object
1 property
GapRequirement-Output
object
A named gap detection rule.
8 properties 2 required
GapScannerSettingsResponse
object
9 properties 9 required
ValidationError
object
5 properties 3 required
GapRequiredField
object
A field that must be present in entity state.
4 properties 2 required
MetricSettingsRequest
object
Partial update — only provided fields are changed. The definitions list is replaced entirely when provided. Built-in metrics can be deactivated (active=false)…
1 property
GapScannerSettingsRequest
object
9 properties
RetentionPolicyRequest
object
7 properties
GapRequirement-Input
object
A named gap detection rule.
8 properties 2 required
DataTemplate-Input
object
Named field template — reusable across multiple outreach rules.
3 properties 2 required
OutreachRule
object
A single outreach rule — defines WHEN, WHAT, and HOW to reach a patient.
12 properties 1 required
EnvironmentSettingsResponse
object
1 property
OutreachSettingsResponse
object
2 properties 2 required
VoiceSettingsResponse
object
Voice experience state — what the PM configured.
14 properties 13 required
OutreachSettingsRequest
object
Partial update — only provided fields are changed. Rules and datatemplates lists are replaced entirely when provided.
2 properties
ChannelType
string
Delivery channels for surfaces.
BrandingSettingsResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-settings-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 Settings 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.