Productivity
Miro in your product and your AI agents, through one API
The Miro toolkit covers boards, board members and items: list and read boards, create and update sticky notes and cards, and delete items. Your product or AI agent calls them through Connect, which handles the customer's OAuth connection and logs every execution.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/miro_create_board/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"name": "<name>"
}
}How it works
From a connected customer to the first Miro call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Miro account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Miro.
Boards created by your product
A SaaS creates a Miro board for each new project and returns the viewLink to the user.
Turn data into sticky notes
An agency or research tool adds sticky notes with feedback or ideas to a board, inside a frame when needed.
Agent that triages a board
An AI agent lists the items of a board, creates cards assigned to members and updates their due dates.
Tools
12 Miro tools
- List boardsGETLists the boards the connected user can open, with id, name, description, viewLink, owner, team and dates. Pagination by offset: the response has total, offset and size, and the list ends when offset plus size reaches total. Boards created a few seconds ago may be missing from a text search, but not from a search by team_id.
- Get boardGETReturns a board: name, description, viewLink, owner, team, sharing policy and dates.
- Create boardPOSTCreates a board in the team of the connection and returns it with its id and viewLink. On the free plan a team can have only 3 editable boards.
- Update boardPATCHUpdates the name, description or sharing of a board and returns it. Fields left out keep their value.
- List board membersGETLists the members of a board with id, name and role. The id is the assigneeId that Create card and Update card ask for. Pagination by offset: the list ends when offset plus size reaches total.
- List itemsGETLists the items of a board, such as sticky notes, cards, text, shapes and frames, with id, type, data, position, geometry and parent. An item inside a frame has the id of the frame in parent.id. The response has cursor: pass it as cursor to read the next page; the list ends when cursor is missing.
- Get itemGETReturns one item of a board, of any type, with its data, style, position, geometry and parent.
- Create sticky notePOSTAdds a sticky note to a board and returns it with its id. Without position it goes to the center of the board; inside a frame (parent.id), the position counts from the top-left corner of the frame.
- Update sticky notePATCHUpdates the text, shape, color, position, size or frame of a sticky note and returns it. Fields left out keep their value.
- Create cardPOSTAdds a card, the task item of Miro, to a board and returns it with its id. Without position it goes to the center of the board; inside a frame (parent.id), the position counts from the top-left corner of the frame.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/miro, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
Questions about the Miro toolkit
Do I need to build against the Miro API?
No. Connect ships 12 Miro tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Miro account?
With the mode the toolkit accepts: OAuth with your product's app. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
