# Platform API

- [Platform API](https://docs.amigo.ai/developer-guide/platform-api/platform-api.md): Platform API reference for voice agents, EHR integration, operators, FHIR, and safety monitoring.
- [Authentication & API Keys](https://docs.amigo.ai/developer-guide/platform-api/platform-api/authentication.md): Workspace-scoped API key authentication, RBAC roles, and key rotation for the Platform API.
- [Workspaces](https://docs.amigo.ai/developer-guide/platform-api/platform-api/workspaces.md): Manage workspaces: tenant isolation, voice settings, speech recognition, and test caller numbers.
- [Agents](https://docs.amigo.ai/developer-guide/platform-api/platform-api/agents.md): Define agent identity, voice, background, and behaviors with immutable versioning in the Platform API.
- [Skills](https://docs.amigo.ai/developer-guide/platform-api/platform-api/skills.md): Configure LLM-backed micro-agent capabilities with system prompts, schemas, and execution tiers.
- [Services](https://docs.amigo.ai/developer-guide/platform-api/platform-api/services.md): Bind agents and context graphs into deployable services with version sets and structured actions.
- [Integrations](https://docs.amigo.ai/developer-guide/platform-api/platform-api/integrations.md): Connect workspaces to external APIs, EHR systems, CRMs, and MCP servers with health checks and endpoint testing.
- [Calls](https://docs.amigo.ai/developer-guide/platform-api/platform-api/calls.md): Trigger outbound voice calls with patient lineage, goal context, and end-to-end traceability in the world model.
- [Conversations](https://docs.amigo.ai/developer-guide/platform-api/platform-api/conversations.md): Text-based agent conversations over REST and WebSocket - full CRUD lifecycle, persistent freeze-thaw, cross-channel continuity.
- [Voice Agent](https://docs.amigo.ai/developer-guide/platform-api/platform-api/voice-agent.md): Real-time voice pipeline with emotion detection, context graph engine, tool execution, and post-call analysis.
- [Voice Configuration](https://docs.amigo.ai/developer-guide/platform-api/platform-api/voice-configuration.md): Per-service voice pipeline tuning for latency, fillers, response limits, barge-in sensitivity, and emotion control.
- [Phone Numbers (Removed)](https://docs.amigo.ai/developer-guide/platform-api/platform-api/phone-numbers.md): Phone number CRUD and Twilio sub-account endpoints have been removed. Use Channel Manager for phone provisioning.
- [Workflows (Removed)](https://docs.amigo.ai/developer-guide/platform-api/platform-api/workflows.md): The workflow feature has been removed from the Platform API.
- [Webhook Destinations (Removed)](https://docs.amigo.ai/developer-guide/platform-api/platform-api/webhook-destinations.md): Webhook destinations have been removed from the Platform API.
- [Workspace Data Queries](https://docs.amigo.ai/developer-guide/platform-api/platform-api/workspace-data-queries.md): Register, manage, and invoke parameterized SQL queries against workspace custom tables.
- [Sessions](https://docs.amigo.ai/developer-guide/platform-api/platform-api/sessions.md): Persistent WebSocket endpoint for low-latency text conversations with streamed agent responses.
- [Workspace Tables](https://docs.amigo.ai/developer-guide/platform-api/platform-api/workspace-tables.md): Create, manage, and query workspace-owned custom data tables.
- [Client Config](https://docs.amigo.ai/developer-guide/platform-api/platform-api/client-config.md): Retrieve client-safe configuration values for embedding in browser-side applications.
- [Prompt Logs](https://docs.amigo.ai/developer-guide/platform-api/platform-api/prompt-logs.md): Query LLM prompt logs for auditing and debugging agent conversations across a workspace.
- [Channels](https://docs.amigo.ai/developer-guide/platform-api/platform-api/channels.md): Manage email channel configurations for your workspace, including SES domain setup and DNS verification.
- [Platform Functions](https://docs.amigo.ai/developer-guide/platform-api/platform-api/functions.md): Register, invoke, test, list, and delete registered platform functions.
- [Text Stream WebSocket](https://docs.amigo.ai/developer-guide/platform-api/platform-api/text-stream-websocket.md): WebSocket endpoint for real-time text conversations with an agent, delivering typed frames for session lifecycle, messages, and tool calls.
- [Scheduling Rule Sets](https://docs.amigo.ai/developer-guide/platform-api/platform-api/scheduling-rule-sets.md): Configure deterministic scheduling rules that filter appointment slots before they reach the agent.
- [Pagination](https://docs.amigo.ai/developer-guide/platform-api/platform-api/pagination.md): How to page through list endpoint results using limit and offset query parameters.
- [Observer Events](https://docs.amigo.ai/developer-guide/platform-api/platform-api/observer-events.md): Real-time event types delivered over the observer WebSocket connection during a voice session.
- [Voice Judge](https://docs.amigo.ai/developer-guide/platform-api/platform-api/voice-judge.md): Retrieve audio-native voice quality scores for your voice agent calls.
- [Metering](https://docs.amigo.ai/developer-guide/platform-api/platform-api/metering.md): Emit usage metering events for tracking consumption and feeding the billing pipeline.
- [Use Cases & Bindings](https://docs.amigo.ai/developer-guide/platform-api/platform-api/use-cases.md): Create, list, and delete channel use cases for voice and email communication.
- [Voicemail](https://docs.amigo.ai/developer-guide/platform-api/platform-api/voicemail.md): Send ringless voicemails and list voicemail delivery records.
- [Channel Manager](https://docs.amigo.ai/developer-guide/platform-api/platform-api/channel-manager.md): Manage workspace communication channel setup and use case provisioning.
- [SSE Events](https://docs.amigo.ai/developer-guide/platform-api/platform-api/sse-events.md): Real-time workspace event stream delivered via Server-Sent Events (SSE).
- [Events](https://docs.amigo.ai/developer-guide/platform-api/platform-api/events.md): Real-time event streaming for workspace activity and call observation.
- [Operators](https://docs.amigo.ai/developer-guide/platform-api/platform-api/operators.md): Human-in-the-loop call monitoring, takeover, escalation management, and operator analytics.
- [Insights](https://docs.amigo.ai/developer-guide/platform-api/platform-api/insights.md): Query workspace data, explore schema metadata, and get health digests through the platform insights endpoints.
- [Call Trace Analysis](https://docs.amigo.ai/developer-guide/platform-api/platform-api/call-trace-analysis.md): Deep call understanding with emotional arcs, key decision moments, coaching recommendations, and signal-response alignment.
- [Data & World Model](https://docs.amigo.ai/developer-guide/platform-api/platform-api/data-world-model.md): Event-sourced world model with confidence scoring, entity graphs, and three-channel data flow.
- [Data Intake](https://docs.amigo.ai/developer-guide/platform-api/platform-api/intake.md): Customer Data Intake endpoint for streaming HMAC-authenticated PHI file uploads into a workspace's landing zone.
- [Connector Runner](https://docs.amigo.ai/developer-guide/platform-api/platform-api/connector-runner.md): Bidirectional sync with external systems (EHR, FHIR store, CRM): entity resolution, confidence-gated writes, outbound handler registry, and call dispatch.
- [Surfaces](https://docs.amigo.ai/developer-guide/platform-api/platform-api/surfaces.md): Agent-generated data collection interfaces: SurfaceSpec, fields, channels, lifecycle, and submission handling.
- [Tool Testing](https://docs.amigo.ai/developer-guide/platform-api/platform-api/tool-testing.md): Test context graph tools in isolation without making phone calls. Execute world tools, skills, and integrations with source isolation and dry run mode.
- [Simulation Coverage](https://docs.amigo.ai/developer-guide/platform-api/platform-api/simulation-coverage.md): Branch-and-bound simulation coverage API for systematic context graph state space exploration.
- [Triggers](https://docs.amigo.ai/developer-guide/platform-api/platform-api/triggers.md): Schedule recurring automated actions with cron-based triggers that dispatch workspace actions on a defined cadence.
- [Platform Functions](https://docs.amigo.ai/developer-guide/platform-api/platform-api/platform-functions.md): SQL, Python, and AI functions that give agents direct access to world model data and analytics during conversations.
- [Safety & Monitoring](https://docs.amigo.ai/developer-guide/platform-api/platform-api/safety.md): Configure semantic monitoring concepts, regulation templates, and workspace safety policies.
- [Analytics & Observability](https://docs.amigo.ai/developer-guide/platform-api/platform-api/analytics.md): Workspace analytics, call management, recording access, and review queue for quality assurance.
- [Metric Store](https://docs.amigo.ai/developer-guide/platform-api/platform-api/metric-store.md): Define custom metrics, evaluate conversations with AI, and query metric values across all channels.
- [FHIR](https://docs.amigo.ai/developer-guide/platform-api/platform-api/fhir.md): FHIR endpoints for patient search, clinical timelines, resource CRUD, and bundle import.
- [Data Access (MCP)](https://docs.amigo.ai/developer-guide/platform-api/platform-api/data-mcp.md): Query workspace data through the Model Context Protocol using SQL tools compatible with any MCP client.
- [SDKs](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk.md): Official TypeScript SDK for the Platform API. Manage agents, calls, analytics, and more.
- [Installation](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk/installation.md): Install the Platform SDK with npm or yarn and configure TypeScript for type-safe API access.
- [Configuration](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk/configuration.md): Configure the Platform SDK client with API keys, workspace ID, and optional base URL overrides.
- [Quickstart](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk/quickstart.md): List agents, inspect a service, and run a voice simulation. Your first Platform SDK calls.
- [Error Handling](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk/error-handling.md): Handle API errors with typed exceptions and built-in retry logic in the Platform SDK.


---

# 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/developer-guide/platform-api.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.
