Miro API
★ Only Publicly Available OpenAPI DocumentProductivityCollaborationbearer21 EndpointsREST
For Agents
Create boards and add sticky notes, shapes, text, connectors, frames, and images on Miro. Manage board members, tags, and organisation teams through a single REST API.
Use for: Create a new Miro board for the planning workshop, Add five sticky notes to the brainstorming board, Draw a connector between two existing shapes, List every item on board abc123
Not supported: Does not handle real-time cursor sync, video conferencing, or document editing — use for programmatic board content and membership management only.
Jentic publishes the only available OpenAPI specification for Miro API, keeping it validated and agent-ready. Miro is a collaborative whiteboard platform whose v2 REST API exposes endpoints for managing boards, board items (sticky notes, shapes, text, connectors, frames, images), board members, tags, and organisation teams. The 21 endpoints cover the core flows for programmatically creating, updating, and reading whiteboard content. Suited to workflow tools, integrations, and AI agents that draft visual artifacts.
Install Jentic One Beta
Connect the Miro API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Miro API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Miro API.
Create a new board with POST /v2/boards and update or archive it via PATCH and DELETE /v2/boards/{board_id}
List items on a board through GET /v2/boards/{board_id}/items and inspect a single item with /items/{item_id}
Add sticky notes, shapes, text, connectors, frames, and images using the dedicated POST endpoints under /v2/boards/{board_id}
Move or restyle existing items via PATCH /v2/boards/{board_id}/items/{item_id} and remove them with DELETE on the same path
Invite collaborators with POST /v2/boards/{board_id}/members and read membership via GET on the same path
Apply taxonomy with GET and POST /v2/boards/{board_id}/tags
List teams and members in an organisation via GET /v2/orgs/{org_id}/teams and /v2/orgs/{org_id}/members
Use Cases
Patterns agents use Miro API for, with concrete tasks.
★ AI-Generated Brainstorm Boards
An agent creates a board with POST /v2/boards, adds frames for each topic, and posts sticky notes generated from a brief. POST /v2/boards/{board_id}/sticky_notes places each idea at coordinates inside the right frame. Useful for kicking off design or planning sessions with structured starting content.
POST /v2/boards, then POST /v2/boards/{board_id}/sticky_notes for each idea with x/y coordinates inside the chosen frame
Diagram Sync from Source of Truth
Render a system diagram on Miro from a source-of-truth definition such as YAML or Terraform state. The agent creates shapes for each node and connectors for each edge via POST /v2/boards/{board_id}/shapes and /connectors. When the source updates, the agent diffs and patches existing items by id rather than rebuilding the board.
POST shapes for each node, POST /v2/boards/{board_id}/connectors with start_item_id and end_item_id for each edge, then PATCH any existing items whose source has changed
Retrospective Capture and Tagging
After a sprint retrospective, an agent reads the items on the retro board, classifies them into 'keep', 'change', and 'try', and applies the corresponding tags via POST /v2/boards/{board_id}/tags and PATCH on each item. Captures the outcome in a structured way without manual tagging.
GET /v2/boards/{board_id}/items, classify each sticky text, then PATCH each /items/{item_id} adding the matching tag
Org and Team Provisioning
Provision new Miro teams as part of HR onboarding by reading existing structure with GET /v2/orgs/{org_id}/teams and adding members to relevant boards via POST /v2/boards/{board_id}/members. Keeps Miro access in sync with the source-of-truth directory without manual board sharing.
GET /v2/orgs/{org_id}/members for the new hire's email, then POST /v2/boards/{board_id}/members on every board where the team should have access
Agent-Driven Whiteboard Content
An AI agent uses Jentic to draft visuals on demand: brainstorms, retros, or architecture views. Jentic scopes the bearer token so the agent never holds it directly, and Jentic surfaces the right item-creation endpoint per intent so the agent does not memorise the catalogue of POST routes.
Search Jentic for 'add a sticky note to a Miro board', load the schema, and post the agent's outputs as sticky notes to the chosen board
Key Endpoints
21 endpoints — jentic publishes the only available openapi specification for miro api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v2/boards
Create a board
GET
/v2/boards/{board_id}/items
List items on a board
POST
/v2/boards/{board_id}/sticky_notes
Add a sticky note
POST
/v2/boards/{board_id}/shapes
Add a shape
POST
/v2/boards/{board_id}/connectors
Add a connector
PATCH
/v2/boards/{board_id}/items/{item_id}
Update an item
POST
/v2/boards/{board_id}/members
Invite a board member
GET
/v2/orgs/{org_id}/teams
List org teams
POST
/v2/boards
Create a board
GET
/v2/boards/{board_id}/items
List items on a board
POST
/v2/boards/{board_id}/sticky_notes
Add a sticky note
POST
/v2/boards/{board_id}/shapes
Add a shape
POST
/v2/boards/{board_id}/connectors
Add a connector
PATCH
/v2/boards/{board_id}/items/{item_id}
Update an item
POST
/v2/boards/{board_id}/members
Invite a board member
GET
/v2/orgs/{org_id}/teams
List org teams
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
The Miro bearer token is stored encrypted in the Jentic vault. Agents call Miro through scoped Jentic execution requests so the token never enters agent context, and OAuth refresh is handled centrally.
Intent-based discovery
Agents search Jentic for intents like 'add a sticky note' or 'create a Miro board' and Jentic returns the matching POST endpoint with its input schema, including the right coordinate and content fields.
Time to first call
Direct Miro integration: 1-2 days to set up OAuth, handle token refresh, and learn the item-type taxonomy. Through Jentic: under an hour — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Miro API through Jentic.
Why is there no official OpenAPI spec for Miro API?
Miro does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Miro API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the Miro API use?
Miro v2 uses HTTP bearer token authentication. Tokens are typically obtained via Miro's OAuth 2.0 install flow and sent in the Authorization header as `Bearer <token>`. Jentic stores the bearer in its vault and injects it per call.
Can I add a sticky note to a Miro board with this API?
Yes. POST /v2/boards/{board_id}/sticky_notes accepts the note text, fill colour, and absolute or frame-relative coordinates. The response includes the new item id, which can be passed to PATCH /v2/boards/{board_id}/items/{item_id} to move or restyle it later.
How do I draw a connector between two items?
First create the source and target items (shape, sticky note, frame, etc.) and capture their item ids. Then POST /v2/boards/{board_id}/connectors with start_item_id and end_item_id; Miro draws the connector between them.
How do I create a Miro board through Jentic?
Run `pip install jentic`, search Jentic for 'create a Miro board', and Jentic returns the POST /v2/boards operation with its input schema. Provide a name and optional description, then execute. The response contains the new board_id.
Can I list members of a Miro organisation?
Yes. GET /v2/orgs/{org_id}/members returns members at the organisation level and GET /v2/orgs/{org_id}/teams returns the teams. Use these endpoints to drive provisioning flows that match Miro access to your directory.
GET STARTED