Documentation
Worked examples
Two conversations as they actually run, tool calls included. The first one carries a validation error on purpose, because watching the assistant correct itself explains the design better than any paragraph.
Building a page from nothing
A token with the read and write scope, on a page that has nothing on it yet. The assistant reads first, gets one call wrong, and fixes it with what the server told it.
- You
I have a small bike repair shop. Set up my page: what I do, a price for the three most common repairs, my hours, and a form to book a repair.
- Assistant
Let me see what the page has now and which blocks I am allowed to use.
- Call
list_pagesAnswerOne page, in draft, reachable by this token.
- Call
get_pageAnswerA header and one empty group.
- Call
list_block_kindsAnswerEvery block type with its variants and its layouts.
- Assistant
I will add services, prices, hours and a booking reason. Starting with prices.
- Call
add_blockAnswerRejected. Unknown variant price-table for a prices block. Valid variants: list, cards, compact.
- Assistant
That variant does not exist. The catalogue offers list, cards and compact, and cards reads better on a phone, so I will use that one.
- Call
add_blockAnswerPrices block added, with the three repairs and their price.
- Call
add_blockAnswerServices, hours and the booking reason added to the same group.
- Call
preview_pageAnswerA preview link for the draft.
- Assistant
The draft has four blocks and a booking form. Open the link, read it in your own voice and publish it yourself when it sounds right. This token cannot publish.
The rejected call is the interesting one. The server did not say no, it said which three variants exist, so the next attempt was right without anyone asking you.
One change across several pages
The same token, three pages, one fact that changed. The assistant works page by page and stops before publishing.
- You
The studio moved. Change the address on all three pages and leave them ready for me to look at.
- Assistant
Let me see which pages this token reaches.
- Call
list_pagesAnswerThree pages: studio, workshop and courses.
- Call
get_pageAnswerEach one carries a location block with the old address.
- Call
update_blockAnswerAddress replaced on the three drafts, one call for each.
- Call
preview_pageAnswerThree preview links, one per page.
- Assistant
Three drafts changed and three links to check. Nothing is live: this token has no publish scope, and even with it the last word would still be yours.
Three pages and seven calls, all of them on the draft. What visitors see did not move until you decided it should.