> For the complete documentation index, see [llms.txt](https://docs.amigo.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.amigo.ai/api-reference/readme.md).

# REST API Specs

Browse the Classic, Platform, and Scribe API contracts, find the matching implementation guide, and interpret Amigo's release history.

This space contains generated REST contracts and release history. Choose the API assigned to your deployment, then inspect its operations and models. Use the [Developer Guide](https://docs.amigo.ai/developer-guide) for setup and integration workflows, and the [conceptual documentation](https://docs.amigo.ai) for architecture and operating boundaries.

## Choose Your Next Step

Use [Current Upgrade Guidance](/api-reference/change-logs/upgrade-guide.md) for compatibility and migration decisions, or the generated Classic and Platform reference below for exact contracts. To build a first working client, follow the [Developer Guide starter](https://docs.amigo.ai/developer-guide/guides/first-verified-conversation). Technical buyers can start with the [evaluation packet](https://docs.amigo.ai/platform-overview/evaluation-packet).

## Choose an API

| Reference                                         | Resource boundary and use                                                                                                                  | Public schema                                                      |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
| [**Platform**](/api-reference/readme/platform.md) | Workspace data, configured agents, voice and messaging workflows, integrations, and operations; some routes have account or identity scope | [Platform OpenAPI](https://api.platform.amigo.ai/v1/openapi.json)  |
| [**Scribe**](/api-reference/readme/scribe.md)     | Provider-owned clinical sessions and artifacts with separate scopes and deployment base                                                    | [Scribe OpenAPI](https://scribe.platform.amigo.ai/v1/openapi.json) |
| [**Classic**](/api-reference/readme/classic.md)   | Organization-scoped users, services, conversations, Actions, Dynamic Behaviors, and simulations                                            | [Classic OpenAPI](https://api.amigo.ai/v1/openapi.json)            |

Platform and Classic credentials, identifiers, and request bodies are not interchangeable. [Getting Started](https://docs.amigo.ai/developer-guide/getting-started) explains the choice and the regional endpoint to configure.

## Read an Operation

The generated pages show the operation's path, method, parameters, body, responses, and schema references from the selected OpenAPI specification. The **Models** pages collect shared schemas; a model's presence alone does not expose a callable operation.

Use the operation's declared server and authentication requirements. A request made with the interactive API client uses real credentials against the selected endpoint. Choose the intended test workspace or organization before executing a mutation.

The schema describes the wire contract. It does not establish provisioning, regional feature availability, permission to perform every listed action, or completion of an asynchronous workflow. The corresponding Developer Guide explains those conditions and the evidence to inspect after a request.

{% content-ref url="/pages/uf7w5MQjCY2ldvmRrVVs" %}
[Platform](/api-reference/readme/platform.md)
{% endcontent-ref %}

{% content-ref url="/pages/JA8hKwAOT6nlOT0Vjw9j" %}
[Classic](/api-reference/readme/classic.md)
{% endcontent-ref %}

## Additional Protocols and Deployments

| Surface                               | Where its contract lives                                                                                                                              |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Provider documentation workflows      | [Scribe](https://docs.amigo.ai/developer-guide/platform-api/scribe), using the supplied deployment base and provider-session credentials              |
| Persistent text WebSocket             | [Platform Sessions](https://docs.amigo.ai/developer-guide/platform-api/platform-api/sessions), including connection parameters, frames, and lifecycle |
| Workspace MCP clients                 | [Platform MCP Server](https://docs.amigo.ai/developer-guide/platform-api/functions/mcp-server)                                                        |
| Classic organization data exploration | [Data-MCP](https://docs.amigo.ai/developer-guide/platform-api/data-world-model/data-mcp), a standalone service with Classic organization credentials  |

Scribe HTTP operations have a [dedicated schema-backed reference](/api-reference/readme/scribe.md). The other protocols are not automatically covered by the generated REST page trees. Follow their individual protocol and authentication guides.

## SDK Ecosystem

| Client              | Package                  | Implementation guide                                                            |
| ------------------- | ------------------------ | ------------------------------------------------------------------------------- |
| Platform TypeScript | `@amigo-ai/platform-sdk` | [Platform SDK](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk) |
| Classic TypeScript  | `@amigo-ai/sdk`          | [Classic SDKs](https://docs.amigo.ai/developer-guide/classic-api/sdks)          |
| Classic Python      | `amigo-sdk`              | [Classic SDKs](https://docs.amigo.ai/developer-guide/classic-api/sdks)          |

Check the [package version snapshot](/api-reference/change-logs.md#current-sdk-packages) and release notes before upgrading. A published SDK can lag the live API schema; use the guide's compatibility notes when a helper and server differ.

## Release History

[Change Logs](/api-reference/change-logs.md) record customer-relevant API, SDK, CLI, and web changes. Historical entries explain what changed at the time. Use the current operation reference and implementation guide to determine what is available now.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.amigo.ai/api-reference/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.