For AI assistants
Your assistant can draw the diagram.
Canvas has a public API with no key and no account. An assistant can turn a plan into a flowchart, a mind map or columns of sticky notes, and hand you a link to a board that is laid out and ready to edit.
What it can do
- Draw a flowchart or mind map from steps and arrows.
- Lay out sticky notes in named columns, for a retro or a brainstorm.
- Read what is on a board while its view link is on, or with its admin key or a working edit key.
- Rename a board, turn its links off or delete it, with the admin key.
Full reference: llms.txt, index.md and openapi.json. Boards made through the API are the same boards people use, and images are capped at 2 MB each.
# Draw a flowchart and get a link to the board curl -X POST https://functions.openapps.xyz/apps/788ba0fa01083b300ad50913/api/boards \ -H 'content-type: application/json' \ -d '{"title": "Checkout flow", "nodes": [{"id": "cart", "label": "Cart"}, {"id": "pay", "label": "Paid?", "shape": "diamond"}, {"id": "done", "label": "Order placed", "shape": "ellipse"}], "edges": [{"from": "cart", "to": "pay"}, {"from": "pay", "to": "done", "label": "Yes"}]}' # Sticky notes in columns, for a retro or a brainstorm curl -X POST https://functions.openapps.xyz/apps/788ba0fa01083b300ad50913/api/boards \ -H 'content-type: application/json' \ -d '{"title": "Sprint 12 retro", "columns": [{"name": "Went well", "color": "green", "notes": ["Shipped search"]}, {"name": "To improve", "color": "red", "notes": ["Flaky tests"]}]}' # Read what is on a board curl https://functions.openapps.xyz/apps/788ba0fa01083b300ad50913/api/boards/BOARD_ID
Questions
Can my AI assistant draw a diagram on Canvas?
Yes. Canvas has a public API with no key. An assistant can send steps and arrows (a flowchart or a mind map) or columns of sticky notes, and gets back a link to a board that is laid out automatically and ready to edit.
Does the API need a key or an account?
No. Making a board and reading one need no key. Renaming a board, turning its links off and deleting it need the board's admin key, sent in the x-admin-key header.
Can an assistant read a board?
Yes, with the board id, as long as the board's view link is on. When the view link is off, the API shows the board only to a caller that sends its admin key, or its edit key while the edit link is on.