# API Terminology Mapping

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                                                                                                                    |
| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Workspace           | `workspace`           | A container that groups skills, agents, and configurations for a specific deployment.                                          |
| Skill               | `skill`               | An LLM-backed micro-agent with five execution tiers: Direct, Orchestrated, Autonomous, Browser, and Computer Use.              |
| Monitor             | `monitor`             | A tracked signal or condition that can trigger alerts or behavior changes.                                                     |
| Operator            | `operator`            | A human staff member who receives escalated conversations with full handoff context.                                           |
| World Model         | `world_model`         | The unified data layer that assembles information from EHR, conversations, and other sources.                                  |
| Connector Runner    | `connector_runner`    | The integration layer that pulls external data into the platform.                                                              |
| Regulation Template | `regulation_template` | A compliance framework encoding regulatory requirements as agent constraints.                                                  |
| Platform Function   | `function`            | A declarative tool (SQL, Python, or AI) that agents call during conversations for data retrieval, scoring, and classification. |
| Encounter Entity    | `encounter`           | A world model entity type for clinical documentation sessions, containing SOAP notes, ICD-10 codes, and clinical alerts.       |
| Metric Store        | `metrics`             | Config-driven workspace-level analytics: 21 built-in metrics, custom metrics with AI extraction, per-metric latency tiers.     |
| Confidence Score    | `confidence_score`    | A numeric measure of agent certainty used for escalation decisions.                                                            |
| Entity Resolution   | `entity_resolution`   | The process of matching records across data sources to a single identity.                                                      |

## Version Set Presets

<details>

<summary>Channel-specific version set presets</summary>

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 (ultra-low latency) | `voice_ultra_low` | Single state only, no memory retrieval               |
| Text                      | `text`            | Unlimited states, all types                          |
| Text (premium)            | `text_premium`    | Same, premium model                                  |
| Async                     | `async`           | Unlimited states, dynamic behaviors                  |
| Async (premium)           | `async_premium`   | Same, premium model                                  |

</details>

{% hint style="info" %}
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`.
{% endhint %}
