# 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: built-in and 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.                                                      |
| Trigger             | `trigger`                            | A cron-to-action binding that dispatches automated actions on a recurring schedule within a workspace.                         |
| Action              | `tool`                               | A versioned code package that an agent can execute during a conversation (Classic API).                                        |
| Dynamic Behavior    | `dynamic_behavior`                   | A runtime rule that fires based on conversation context to modify agent behavior.                                              |
| Surface             | `surface`                            | An agent-generated data collection form delivered via SMS, WhatsApp, email, or web.                                            |
| Data Source         | `data_source`                        | A configured external system connection (EHR, FHIR, CRM, REST, webhook, file drop).                                            |
| Review Queue Item   | `review_queue_item`                  | A world model event flagged for human review before confidence promotion.                                                      |
| 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.                                            |
| Agent               | `agent`                              | The persona and configuration that defines how an AI assistant behaves.                                                        |
| Service             | `service`                            | A deployed instance binding an agent, context graph, and channel configuration.                                                |
| Session             | `session`                            | An active conversation instance between an agent and a participant.                                                            |
| Voice Settings      | `voice_settings`                     | Workspace-level TTS provider selection, voice configuration, and language settings.                                            |
| Persona             | `persona`                            | A named personality profile defining the agent's communication style and 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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.amigo.ai/reference/api-terminology-mapping.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.