What the assistant can do
Published Updated
Every action the connection makes available, grouped by the job it belongs to, and marked as either a read (looks at something) or a write (can change something). This is the precise list, for readers who want it. You need none of it to use the connection day to day.
Coming back to this page? The Changelog at the bottom records what has been added or removed and when.
Two kinds of action
Every action is one or the other, and your assistant is told which is which.
Read looks at something and changes nothing. Safe to run at any time, and the group you can set to Always allow so you are not asked every time.
Write can change something on your account: a page, a menu, an image, a stored setting. These keep asking your permission.
Brands and audience
These work whether or not your pages are built with us.
| Action | Kind | What it does |
|---|---|---|
get_brands | Read | Lists the brands on your account. Searchable by name, domain or niche. |
get_brand_details | Read | One brand in full: domains, login and join links, branding, niche, and its lifetime totals. |
get_demographics | Read | The members a brand has now, by country, region or city, split into age bands. |
get_interests | Read | The brand's interest labels, for writing copy that sounds like its niche. |
get_member_reviews | Read | Members and the reviews they left, filterable by star rating. |
get_polls | Read | The brand's polls, sorted by popular or recent. |
get_poll | Read | One poll's full results, including a breakdown per answer. |
get_pricing | Read | The memberships a brand really sells: tiers, lengths and prices in every currency it takes. The only source for a price on a page. |
search_brands_with_playground_data | Read | Feeds the brand picker in our own interface. There is no reason to ask for it directly. |
Finding pages
| Action | Kind | What it does |
|---|---|---|
find_pages | Read | Finds pages on a brand by keyword. |
get_page_details | Read | One page's path, template, titles and descriptions, indexing flag, and whether the live page has caught up with its last edit. |
list_deleted_pages | Read | Finds pages that were deleted, so they can be brought back. |
Reading and changing pages
| Action | Kind | What it does |
|---|---|---|
read_page | Read | Reads a page's stored source, which is the version that can be edited and sent back. |
edit_page | Write | Changes one passage of a page, leaving the rest untouched. The usual way a small change is made. |
write_page | Write | Replaces a page's whole source. Used when a page is rebuilt rather than tweaked. |
create_canvas_studio_page | Write | Creates a new empty page at a path you choose, ready to be written. |
update_page_metadata | Write | Sets a page's title, description, keywords, share title and description, and whether search engines may index it. |
delete_page | Write | Deletes a page. Recoverable, not permanent. Refused for a brand's home page or its last remaining page. |
restore_deleted_page | Write | Brings a deleted page back, at a path you choose. Menu links that pointed at it are not restored with it. |
move_page | Write | Moves a page, or a whole section, to a new address. Not working through the connection at the moment, so move a page in the portal instead and tell us if you need this. |
Only canvas pages have a source to edit. Pages built from a template, which includes /about-us and the home page on some older brands, are assembled by the platform from content it holds. read_page comes back empty on those and the three writing actions refuse them. The reply names the template and links straight to where the page's content is edited in the portal. update_page_metadata still works on them.
Menus and navigation
Menu changes rebuild every live page that shows the menu, so they take a moment to appear.
| Action | Kind | What it does |
|---|---|---|
get_menus | Read | A brand's menus, their items in order, and which pages use each one. |
get_page_menus | Read | Which menus one page uses, and whether those regions are shown. |
get_menu_value_options | Read | The accepted values for menu fields, so a change uses the right ones. |
set_page_menus | Write | Assigns or clears a page's navigation and footer menus, and shows or hides those regions. |
add_menu | Write | Creates a new, empty menu for a brand. |
delete_menu | Write | Deletes a menu and its items permanently. Refused while any page still uses it. |
add_menu_item | Write | Adds an item to a menu: a page, an external link, a members or login page, or a dynamic route. |
update_menu_item | Write | Changes a menu item's label, destination, icon or visibility. |
delete_menu_item | Write | Removes a menu item permanently. Anything nested under it moves up rather than disappearing. |
reposition_menu_item | Write | Moves an item to a different position in its menu. |
set_auto_menu_management | Write | Turns automatic menu management on or off, which decides whether the platform maintains menu items for you. |
Images and files
| Action | Kind | What it does |
|---|---|---|
list_assets | Read | Lists a brand's files with their addresses and sizes. |
upload_image | Write | Uploads a small image and returns its address. Resizing and format are chosen later by editing that address. |
prepare_image_upload_session | Write | Opens an upload for a larger image, so the file itself never passes through the conversation. |
watch_image_upload_session | Read | Waits for that upload to land and reports the address, dimensions and size. |
prepare_zip_upload_session | Write | Opens an upload for a whole archive of pages and files. Matching pages are rewritten and new ones created, so agree the contents first. |
watch_zip_upload_session | Read | Follows that upload and reports what was stored, page by page, with a hash proving each one. |
Exporting a site
| Action | Kind | What it does |
|---|---|---|
export_site | Write | Builds a download of a whole brand. Changes nothing on the site; it queues a job. |
export_site_selected | Write | The same for chosen pages or a section, optionally without images, which is far quicker. |
get_export_status | Read | Progress of an export and, once ready, the download link. The link lasts an hour. |
get_site_export_manifest_data | Read | Lists what an export would contain, so a selection can be made before running one. |
Going live
A change is stored first and appears on the live page a moment later, once the page has rebuilt.
| Action | Kind | What it does |
|---|---|---|
get_render_status | Read | Whether a brand's live pages have caught up with their last change, and which have failed. |
rerender_pages | Write | Asks the platform to rebuild live pages from what is stored. It changes no content, so it is not the fix for a page that is wrong. |
What is not on the list
Worth knowing, because an absence is easy to mistake for the assistant being unhelpful.
- Creating a brand. That happens in the portal.
- Rewriting a template page's wording. Only canvas pages have a source to edit, as above. The content of a template page is changed in the portal, and the assistant will point you at it.
- Editing the site stylesheet on its own. A whole archive can be uploaded, and a file in it replaces the one the brand already has, but there is no action for changing one stylesheet in place.
- Figures over a period. You can read who your members are now, but registrations, clicks and revenue for a date range are not here yet.
- Anything to do with members themselves. No messaging, no accounts, no moderation. The connection is about your brands and their pages.
Changelog
| Release | Changes |
|---|---|
| 16 September 2026 | Said plainly that only canvas pages have a source to edit, and that the content of a template page such as /about-us is changed in the portal. Added as a note under the page actions and as an entry under what is not on the list. |
| 7 September 2026 | Checked against the platform and corrected. Added the actions that were missing: creating a menu and a menu item, reading a brand's real pricing, checking whether live pages have caught up, rebuilding them, moving a page and restoring a deleted one. Removed five entries for actions that no longer exist, which were duplicates of ones already listed. Corrected the note that said restoring a deleted page and moving a page were not available; both are listed now, and moving is flagged as not working through the connection yet. |
| 3 September 2026 | Page first published on the Help Centre. |