For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Terminology Mapping

Map between conceptual documentation names and API endpoint paths, SDK resources, and streaming event types.

The Amigo platform documentation uses conceptual names that are easier to understand, while the API uses internal system names. This page maps between them so you can connect what you read in the docs to what you see in the API.

Platform API Mappings

Conceptual Name
API Name
Description

Action

tool

A versioned code package that an agent can execute during a conversation (Classic API).

Call Timeline

timeline

Lane-based playback model with actor-attributed segments and shared timebase.

Context Graph

service_hierarchical_state_machine

A hierarchical state machine that structures conversation flow and agent reasoning.

Dynamic Behavior

dynamic_behavior_set

A runtime rule that fires based on conversation context to modify agent behavior.

Metric Store

metrics

Config-driven workspace-level analytics: built-in and custom metrics with AI extraction, per-metric latency tiers.

Platform Function

function

A declarative tool (SQL, AI, Python, or table-valued function) that agents call during conversations for data retrieval, scoring, and classification.

All other resources - workspaces, agents, services, sessions, skills, personas, surfaces, triggers, operators, and the rest - use the same name in the documentation and the API, rendered in snake case in API paths and payloads (for example, Connector Runner is connector_runner).

Version Set Presets

Channel-specific version set presets

Version set presets configure the agent's behavior profile for different channels.

Channel
Preset Name
Notes

Voice (standard)

voice

Max 5 states, action/annotation/tool-call types only

Voice (premium)

voice_premium

Same constraints, premium model

Voice (economy)

voice_economy

Same constraints, cost-optimized model

Voice (ultra-low latency)

voice_ultra_low

Single state only, no memory retrieval

Voice (ultra-low latency, premium)

voice_ultra_low_premium

Single state only, no memory retrieval, premium model

Text

text

Unlimited states, all types

Text (premium)

text_premium

Same, premium model

Text (economy)

text_economy

Same, cost-optimized model

Async

async

Unlimited states, dynamic behaviors

Async (premium)

async_premium

Same, premium model

Async (economy)

async_economy

Same, cost-optimized model

The OpenAPI spec is the definitive source for all endpoint paths, parameter names, and response schemas. Access it from your API base URL at /openapi.json.

Last updated

Was this helpful?