## Miro API clients

> **⚠️ Retirement Notice**
>
> The Miro API client libraries in this repository are being retired. **No new versions of these clients will be published after November 1, 2026.**
>
> Given the rapidly changing AI landscape, we believe it is better for every organization to implement their own clients tailored to their specific needs, rather than maintaining a single public client library.
>
> **What this means for you:**
> - The existing published packages will remain available but will receive no further updates.
> - We will continue to maintain and update the [OpenAPI specification](./packages/generator/spec.json), so you can generate your own clients using tools like [OpenAPI Generator](https://openapi-generator.tech/) or [openapi-ts](https://github.com/hey-api/openapi-ts).
> - We recommend migrating to a self-generated or custom client before the retirement date.
> - If you are an enterprise customer and you have additional questions please reach out to your Customer Support Representive
> 
> Thank you to everyone who contributed to and used these clients.

---

This repository contains Miro API clients and the tools needed to generate them, based on the OpenAPI specification (OAS).
Currently, we have a [Node.js client](./packages/miro-api), written in [TypeScript](https://www.typescriptlang.org/) and a [Python client](https://github.com/miroapp/api-clients/tree/main/packages/miro-api-python)

Contribution to this project is open and welcome! Read our [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines to get started. Thank you for your help!

### Miro Node.js client

- [Miro Node.js client reference documentation](https://miroapp.github.io/api-clients/node/index.html)

- [Miro Python client reference documentation](https://miroapp.github.io/api-clients/python/miro_api.html)