Build and host websites from a chat: draft free, edit and theme, then publish to your own domain.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Adds a new page (e.g. "/about", "/contact") to an existing site, built from html (same importer as create_site_from_html) or composed from sections/content_json in the site's own palette and fonts. Link between pages with href="/about". Respects the plan's page limit; stage:true previews it before it goes live. Free.
The new page's path, e.g. "/about" or "/contact": lowercase letters, digits and hyphens, at most 19 characters. Link to it with href="/about".
Build the page from this HTML (same importer as create_site_from_html). Omit to compose it from sections instead.
The page name shown in the editor's page list. Defaults to one made from the path ("Contact Us").
true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit.
Comma-separated section kinds to compose the page from when html is omitted: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews. Defaults to about.
The site to add a page to. Defaults to the caller's current draft site when omitted.
The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header.
Per-section content keyed by section kind, exactly as create_site_from_brief's content_json. Styled with the site's own palette and fonts.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http pagetool https://pagetool.io/api/mcp
Adds a new page (e.g. "/about", "/contact") to an existing site, built from html (same importer as create_site_from_html) or composed from sections/content_json in the site's own palette and fonts. Link between pages with href="/about". Respects the plan's page limit; stage:true previews it before it goes live. Free.
| Argument | Type | Description |
|---|---|---|
| html | string | Build the page from this HTML (same importer as create_site_from_html). Omit to compose it from sections instead. |
| name | string | The page name shown in the editor's page list. Defaults to one made from the path ("Contact Us"). |
| path* | string | The new page's path, e.g. "/about" or "/contact": lowercase letters, digits and hyphens, at most 19 characters. Link to it with href="/about". |
| stage | boolean | true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit. |
| sections | string | Comma-separated section kinds to compose the page from when html is omitted: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews. Defaults to about. |
| site_key | string | The site to add a page to. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
| content_json | any | Per-section content keyed by section kind, exactly as create_site_from_brief's content_json. Styled with the site's own palette and fonts. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"path"
],
"properties": {
"html": {
"type": "string",
"description": "Build the page from this HTML (same importer as create_site_from_html). Omit to compose it from sections instead."
},
"name": {
"type": "string",
"description": "The page name shown in the editor's page list. Defaults to one made from the path (\"Contact Us\")."
},
"path": {
"type": "string",
"description": "The new page's path, e.g. \"/about\" or \"/contact\": lowercase letters, digits and hyphens, at most 19 characters. Link to it with href=\"/about\"."
},
"stage": {
"type": "boolean",
"description": "true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit."
},
"sections": {
"type": "string",
"description": "Comma-separated section kinds to compose the page from when html is omitted: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews. Defaults to about."
},
"site_key": {
"type": "string",
"description": "The site to add a page to. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
},
"content_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": {}
}
],
"description": "Per-section content keyed by section kind, exactly as create_site_from_brief's content_json. Styled with the site's own palette and fonts."
}
},
"additionalProperties": false
}Adds ONE section of any kind (menu, map, faq, hours, ...) to an existing site, styled like the rest of it, without rebuilding the site. Pass content_json with that section's keys (or html with your own markup instead of kind), and position to choose where it goes (default: end, before the footer). Saves an undo version first; stage:true previews it before it goes live. Free. In the result, section_count is the number of nodes in the page tree (nested ones included), NOT the number of sections; listed_section_count is the number of top-level sections and matches what list_sections returns.
| Argument | Type | Description |
|---|---|---|
| html | string | Instead of kind: your own markup for the new section(s), e.g. "<section>...</section>" with its own <style>. Imported like create_site_from_html (the result includes its import report). Best for sites built from HTML. Give kind or html, not both. |
| kind | string | The kind of section to add: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews. |
| page | string | Which page of the site, as its path ("/about", "/contact"). Omit for the home page. See list_pages. |
| stage | boolean | true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit. |
| colors | object | Optional, for kind "map" only. Colours for the new map as 6-digit hex like #1a1a1a: background, text, accent (the link). Leave out to match the section next to it on an imported page. |
Removes one of your own UNPUBLISHED sites from your account so it no longer appears in list_sites (for example test sites). Nothing is deleted: it is the same recoverable archive the dashboard uses. Live sites, and sites with an active client pay link, are refused. Signed-in accounts only. Free.
| Argument | Type | Description |
|---|---|---|
| site_key* | string | The site to archive. Must be yours and NOT published (a live site is refused). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key"
],
"properties": {
"site_key": {
"type": "string",
"description": "The site to archive. Must be yours and NOT published (a live site is refused)."
}
},
"additionalProperties": false
}Retires a pay link that has NOT been paid (give code = the pcl_… part of pay_url, or site_key), so nobody can pay it. Nothing is charged. A link that was already paid cannot be cancelled here.
| Argument | Type | Description |
|---|---|---|
| code | string | The link code: the pcl_… part at the end of pay_url. |
| site_key | string | Or the site whose open pay link to cancel. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"code": {
"type": "string",
"description": "The link code: the pcl_… part at the end of pay_url."
},
"site_key": {
"type": "string",
"description": "Or the site whose open pay link to cancel."
}
},
"additionalProperties": false
}Creates a pay link (pay_url) for a business owner with NO Pagetool account: they pay by card (US cards only) a monthly subscription (default $25/month, or price_cents) that registers the domain, keeps it renewed and puts the site live on it automatically. If they cancel, or stay unpaid past the grace period, the site comes down. The link expires at expires_at. Signed-in accounts only. Free to create; it never charges you. A refused or unchecked domain ending carries `reason` and a plain `reason_text`: unsupported or price_unavailable mean we do not sell that ending right now; lookup_failed or cap_reached mean it was NOT checked, so search again, and never tell the customer we do not sell it.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The domain to register for them, bare, e.g. "joesbakery.com". Must be available; .com/.net/.org and other Cloudflare endings for now. |
| dry_run | boolean | true = quote only: runs every check and returns price, setup fee and registrar, but creates NO pay link. |
| interval | string | Billing interval. Defaults to month. |
| site_key* | string | The site the business is paying for (must be yours, and not yet live on a domain). |
| price_cents | integer | Custom price in cents per interval. Omit for the default ($25/month). Required when the domain costs more than $20/year. |
| business_name | string |
BUILD FIRST, ASK LATER. Creates a complete, live draft website in one call - free, instant, no account and no sign-in. Call this as soon as someone asks for a website, using whatever you already know and sensible defaults for the rest, then show them the returned preview_url and refine it with edit_section and set_theme. Do not interview the user first. Composition is deterministic and no language model is involved, so anything you leave blank renders as a visible placeholder rather than invented copy. You can edit or claim this draft for 7 days from creation.
| Argument | Type | Description |
|---|---|---|
| tagline | string | Short tagline/subheading, max 200 chars. |
| sections | string | Comma-separated section kinds to include, in order, e.g. "hero,about,services,contact". Allowed values: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews. Defaults to hero,about,services,contact when omitted. |
| template | string | Optional starter template - the same ones people pick in the editor. storefront: products with buy buttons, why-us, shipping FAQ. event: a recurring night - what to expect, rules, sign-up, where. shop: a place to visit - story, hours, photos, map, socials. services: services with prices, reviews, service area, hours. nonprofit: mission, get involved, give. Your fields win: sections replace the template sections; content_json replaces it per kind, other kinds keep the sample text. business_name is still required. |
| font_body | string | Body font family name. Defaults to Inter. |
| site_name | string |
BUILD FIRST. Creates a live draft site from HTML you already have - free, instant, no account and no sign-in, fully deterministic with no language model involved. Call it immediately when the user brings you markup, then show them the returned preview_url. Choose create_site_from_brief instead when you are authoring the site yourself and want every section to stay editable in the Pagetool editor: this route keeps the markup verbatim and the flattening is ONE-WAY. Both routes end in the same hosted, publishable site. Scripts, event handlers and javascript: links are always stripped, and external, data: and framework-internal image URLs are dropped and reported back to you. You can edit or claim this draft for 7 days from creation.
| Argument | Type | Description |
|---|---|---|
| html | string | The raw HTML to import. A full document or a bare fragment/section both work. Max 2 MB. Include the page CSS in a <style> block - inline and <style> CSS are mapped to the site styling; external stylesheet links are not fetched. To build several pages at once, pass pages instead. |
| pages | array | Build a whole site in one call instead of html: a list of up to 10 pages, each { path, html, name? }, exactly one with path "/" (the home page), e.g. [{"path":"/","html":"..."},{"path":"/about","html":"..."}]. Link between pages with href="/about". Every page is checked before anything is created. |
| site_name | string | Optional display name for the site (defaults to the document title, or "Imported site"). |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
Creates a one-time link that hands a managed site to a departing client: they sign in or sign up and accept, and the site (and, by default, its domain) moves to their account. The link works once and expires at expires_at; creating a new one cancels the previous one. Signed-in accounts only.
| Argument | Type | Description |
|---|---|---|
| site_key* | string | The managed site to hand over to a departing client. |
| include_domain | boolean | Move the site's connected domain with it (default true). When false the site moves unpublished and the domain stays with this account. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key"
],
"properties": {
"site_key": {
"type": "string",
"description": "The managed site to hand over to a departing client."
},
"include_domain": {
"type": "boolean",
"description": "Move the site's connected domain with it (default true). When false the site moves unpublished and the domain stays with this account."
}
},
"additionalProperties": false
}Drops a site's staged changes without touching the live site. Free.
| Argument | Type | Description |
|---|---|---|
| site_key | string | The site whose staged changes should be dropped. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"site_key": {
"type": "string",
"description": "The site whose staged changes should be dropped. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}Completes registration for a domain the customer has ALREADY paid for. It never charges, and it never reports success it has not confirmed.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The full domain to register, e.g. example.com. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The full domain to register, e.g. example.com."
}
},
"additionalProperties": false
}Checks availability and price for a domain, or for a bare name across a set of TLDs. Free and needs no account. Use it once the user wants their finished draft on a real address. A refused or unchecked domain ending carries `reason` and a plain `reason_text`: unsupported or price_unavailable mean we do not sell that ending right now; lookup_failed or cap_reached mean it was NOT checked, so search again, and never tell the customer we do not sell it.
| Argument | Type | Description |
|---|---|---|
| tlds | string | Comma-separated TLDs to check a bare name against, e.g. "com,io". Ignored when query is a full domain. |
| limit | integer | Max number of results to return (default: all, max 25). |
| query* | string | A full domain (name.tld) or a bare name to check across TLDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"tlds": {
"type": "string",
"description": "Comma-separated TLDs to check a bare name against, e.g. \"com,io\". Ignored when query is a full domain."
},
"limit": {
"type": "integer",
"description": "Max number of results to return (default: all, max 25)."
},
"query": {
"type": "string",
"description": "A full domain (name.tld) or a bare name to check across TLDs."
}
},
"additionalProperties": false
}Moves an anonymous draft onto the account of the signed-in user after they have authorized. Call this only once the user has said they want to keep the site - never before, and never as a precondition for building.
| Argument | Type | Description |
|---|---|---|
| draft_token | string | The draft token to claim. Falls back to the x-pagetool-draft-token header when omitted. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"draft_token": {
"type": "string",
"description": "The draft token to claim. Falls back to the x-pagetool-draft-token header when omitted."
}
},
"additionalProperties": false
}Mints an anonymous draft identity (a draft token) with no account and no sign-in. You usually do NOT need to call this first: create_site_from_brief and create_site_from_html mint one for you and return it. Use this only when you want the token before composing anything. You can edit or claim this draft for 7 days from creation.
| Argument | Type | Description |
|---|---|---|
| name | string | Optional display name for the draft site. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Optional display name for the draft site."
}
},
"additionalProperties": false
}Changes one node of a site - text, title, styling, link, image, heading level - or removes it and its descendants when remove is true. Address a section with section_id (from list_sections) or index, then aim at the node inside it with field (e.g. "heading", "body", "items[1].title"); list_sections shows every section's fields. Text goes on text nodes only: content aimed at a container is refused with the right field names. Free, and no account is needed for a draft you created.
| Argument | Type | Description |
|---|---|---|
| alt | string | New alt text for an image section. |
| src | string | New image/media source (same URL scheme rules as href). |
| href | string | New link target (http:, https:, mailto:, tel:, a path starting with /, or an in-page anchor like #pricing). |
| page | string | Which page of the site, as its path ("/about", "/contact"). Omit for the home page. See list_pages. |
| field | string | Which node inside the addressed section to change, from that section's fields in list_sections: "heading", "body", "text[n]", "links[n]", "image", "items[n].title", "items[n].body", "items[n].price", "items[n].link", "items[n].image". A card with no link or photo yet: set field "items[n].link" with href (and optional content as the label) or "items[n].image" with src, and it is created. "items[n]" addresses the whole card (use with remove: true to delete one card). Omit to change the addressed node itself. |
| index | integer | The section (or node) index to edit or remove. Indices SHIFT/renumber whenever an earlier section is removed elsewhere on the page, so an index recorded before a removal may now point at a different section. Prefer section_id; call list_sections first (or after any removal) to get each section's CURRENT index and its stable section_id, which never changes. Give index, section_id, or both (they must agree). |
Renders a site to a single self-contained HTML file. Paying customers only: requires a signed-in bearer token and an entitlement, so anonymous drafts do not export.
| Argument | Type | Description |
|---|---|---|
| site_key* | string | The site to export. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key"
],
"properties": {
"site_key": {
"type": "string",
"description": "The site to export."
}
},
"additionalProperties": false
}Returns the shareable preview URL for a site, plus its expiry. The create tools already return this URL, so call this only when you need it again later. Free, and no account is needed for a draft you created. You can edit or claim this draft for 7 days from creation.
| Argument | Type | Description |
|---|---|---|
| share_id | string | Alternative lookup by share id, honoured only when it belongs to the caller. |
| site_key | string | The site to preview. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"share_id": {
"type": "string",
"description": "Alternative lookup by share id, honoured only when it belongs to the caller."
},
"site_key": {
"type": "string",
"description": "The site to preview. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}Copies a photo from a public URL (e.g. the business's own website) into Pagetool's image store and returns its hosted url. Use that url in content_json (hero/about/card/gallery image), in edit_section src, or in <img src> for create_site_from_html - external image URLs are otherwise dropped. JPEG, PNG, WebP, GIF or AVIF up to 10 MB; resized to 1600px WebP and safety-checked. No public URL (e.g. photos the owner took)? Send data_base64 instead - downscale large photos first. Counts against the site owner's image allowance.
| Argument | Type | Description |
|---|---|---|
| url | string | Public http(s) URL of a JPEG, PNG, WebP, GIF or AVIF image (e.g. a photo on the business's own website). Never SVG. Max 10 MB. Give url OR data_base64, not both. |
| format | string | Stored format. Default "webp" (smallest). Use "jpeg" for an image you will set as og_image_url (a link-preview share card), because some preview scrapers do not render WebP. |
| filename | string | Optional original file name, for your own reference; the type is detected from the bytes. |
| site_key | string | The site the image is for; it counts against that site owner's image allowance. Defaults to the caller's current draft site when omitted. |
| data_base64 | string | The image itself, base64-encoded (or a data:image/...;base64, URL) - for photos with no public URL, e.g. ones the owner took. Same types and 10 MB limit; downscale large photos before sending. Give url OR data_base64, not both. |
| draft_token | string |
Lists the entries visitors sent through a site's built-in forms, newest first: the submitted fields, whether the notification email was sent, and when. Optional form_key narrows it to one form. limit defaults to 50 (max 200). No visitor IP data is returned. Test entries sent from a staged preview are left out unless include_preview is true. Free.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many entries, newest first. Default 50, max 200. |
| form_key | string | Optional: only entries from this form. |
| site_key* | string | The site whose form entries to list. Must be yours. |
| include_preview | boolean | Also list test entries sent from a staged preview (they are marked as preview entries). Default false. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key"
],
"properties": {
"limit": {
"type": "integer",
"description": "How many entries, newest first. Default 50, max 200."
},
"form_key": {
"type": "string",
"description": "Optional: only entries from this form."
},
"site_key": {
"type": "string",
"description": "The site whose form entries to list. Must be yours."
},
"include_preview": {
"type": "boolean",
"description": "Also list test entries sent from a staged preview (they are marked as preview entries). Default false."
}
},
"additionalProperties": false
}Lists every page of a site (home first) with its path, name, draft preview URL and live URL. Use the path as the page parameter of edit_section, add_section, list_sections and the version tools. Free.
| Argument | Type | Description |
|---|---|---|
| site_key | string | The site whose pages to list. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"site_key": {
"type": "string",
"description": "The site whose pages to list. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}For one site: whether publishing with the operator token needs a review (enforced), the current draft and staged versions (what record_review must name), and the reviews recorded so far, newest first.
| Argument | Type | Description |
|---|---|---|
| site_key* | string | The site whose reviews and current reviewable versions to list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key"
],
"properties": {
"site_key": {
"type": "string",
"description": "The site whose reviews and current reviewable versions to list."
}
},
"additionalProperties": false
}Lists a site's top-level sections in order - each one's CURRENT index, its stable section_id, its kind, its heading, and its fields (every editable node inside it: heading, body, items[n].title, ... with each node's index and current text) - so you can aim edit_section at exactly the right node with section_id + field. Indices shift whenever an earlier section is removed, so list the sections again after any removal instead of reusing an index you recorded earlier. section_count here is the number of top-level sections listed (the same number as listed_section_count in add_section / edit_section results; their section_count counts every node in the tree). Free, and no account is needed for a draft you created.
| Argument | Type | Description |
|---|---|---|
| page | string | Which page of the site, as its path ("/about", "/contact"). Omit for the home page. See list_pages. |
| stage | boolean | true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit. |
| site_key | string | The site to list. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "string",
"description": "Which page of the site, as its path (\"/about\", \"/contact\"). Omit for the home page. See list_pages."
},
"stage": {
"type": "boolean",
"description": "true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit."
},
"site_key": {
"type": "string",
"description": "The site to list. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}Lists every site you own, newest first - site_key, name, preview_url and when that preview link expires, whether it is published and on which domain, and when it was created and last changed. Signed in (OAuth) it lists your account; with a draft_token it lists that draft. Read-only and free.
| Argument | Type | Description |
|---|---|---|
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}Lists a site's saved versions, newest first - version_id, why it was saved, its label, whether an AI edit made it (ai: true), and when. Every edit_section and set_theme call saves the page first, so any AI edit can be undone with restore_version. Free, and no account is needed for a draft you created.
| Argument | Type | Description |
|---|---|---|
| page | string | Which page of the site, as its path ("/about", "/contact"). Omit for the home page. See list_pages. |
| site_key | string | The site whose undo history to list. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "string",
"description": "Which page of the site, as its path (\"/about\", \"/contact\"). Omit for the home page. See list_pages."
},
"site_key": {
"type": "string",
"description": "The site whose undo history to list. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}For a published domain of your site: https root 200, http and www reach https://<domain>/ in one hop, title/description/og tags name the site, og:image is a 1200x630 PNG/JPEG, the favicon is the site's own, no editor leftovers, outbound links answer, exactly one h1, no draft badge. Returns PASS/WARN/FAIL per check. stored:true returns the automatic report made about two minutes after publish_site.
| Argument | Type | Description |
|---|---|---|
| name | string | The person or business the title and og tags must name. Defaults to the site name. |
| domain* | string | The published domain to check, e.g. "angelamcgraw.com". |
| stored | boolean | true = return the newest stored report (including the automatic one ~2 minutes after publish_site) without fetching. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"name": {
"type": "string",
"description": "The person or business the title and og tags must name. Defaults to the site name."
},
"domain": {
"type": "string",
"description": "The published domain to check, e.g. \"angelamcgraw.com\"."
},
"stored": {
"type": "boolean",
"description": "true = return the newest stored report (including the automatic one ~2 minutes after publish_site) without fetching."
}
},
"additionalProperties": false
}Read-only, truthful status of the payments and domains of the customer - use it to tell them exactly where their money and their domain stand.
| Argument | Type | Description |
|---|---|---|
| domain | string | Optionally narrow to a single domain, e.g. example.com. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"domain": {
"type": "string",
"description": "Optionally narrow to a single domain, e.g. example.com."
}
},
"additionalProperties": false
}Operator token only, during a "code prowess" build the owner authorized with a spending cap. Buys ONE domain for the business through our registrar (owner-paid; no customer charge), points it at the server and starts HTTPS. Use dry_run first to compare endings. Exact business name within the cap beats a cheaper near-miss. Auto-renew stays off. Then publish_site and poll publish_status. A refused or unchecked domain ending carries `reason` and a plain `reason_text`: unsupported or price_unavailable mean we do not sell that ending right now; lookup_failed or cap_reached mean it was NOT checked, so search again, and never tell the customer we do not sell it.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The ONE domain to buy for this business, bare, e.g. "heapy.net". Pick the exact business name on any ending that fits the grant's remaining cap before a cheaper misspelling (heapy.net at $90 beats heeepy.com at $40). Check prices first with dry_run. |
| dry_run | boolean | true = quote only: registrar, cost for the minimum term, and whether it fits the cap. Buys nothing. |
| site_key | string | The site this domain is for (optional; for your own bookkeeping). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The ONE domain to buy for this business, bare, e.g. \"heapy.net\". Pick the exact business name on any ending that fits the grant's remaining cap before a cheaper misspelling (heapy.net at $90 beats heeepy.com at $40). Check prices first with dry_run."
},
"dry_run": {
"type": "boolean",
"description": "true = quote only: registrar, cost for the minimum term, and whether it fits the cap. Buys nothing."
},
"site_key": {
"type": "string",
"description": "The site this domain is for (optional; for your own bookkeeping)."
}
},
"additionalProperties": false
}Puts a finished site live on the domain the user has connected. publish_site takes no payment itself; it requires a signed-in account with the pagetool.sites.write scope and either an active plan or an open free trial. Everything before it - building, editing, theming, previewing - is free and account-free, so build first and come here only when the user says they want to keep the site.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The domain to publish to, e.g. "example.com". |
| site_key* | string | The site to publish. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key",
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain to publish to, e.g. \"example.com\"."
},
"site_key": {
"type": "string",
"description": "The site to publish."
}
},
"additionalProperties": false
}Makes a site's staged changes (edit_section/set_theme with stage: true) live. The live page is saved as a version first, so this can be undone with restore_version. Free.
| Argument | Type | Description |
|---|---|---|
| site_key | string | The site whose staged changes should go live. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"site_key": {
"type": "string",
"description": "The site whose staged changes should go live. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}For a domain your site uses: does DNS point at our server, is the HTTPS certificate in place, and does the page answer? live:true means a visitor can open https://<domain> now. A fresh domain usually takes 5-15 minutes; poll every 20-30 seconds.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The domain to check, e.g. "heapy.net". Poll every 20-30 seconds after publish_site until live is true. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain to check, e.g. \"heapy.net\". Poll every 20-30 seconds after publish_site until live is true."
}
},
"additionalProperties": false
}Charges the saved card of the customer immediately for a purchase they have explicitly agreed to in this conversation. Only call it after they have confirmed the exact item and amount in words - this tool moves real money right away. A refused or unchecked domain ending carries `reason` and a plain `reason_text`: unsupported or price_unavailable mean we do not sell that ending right now; lookup_failed or cap_reached mean it was NOT checked, so search again, and never tell the customer we do not sell it.
| Argument | Type | Description |
|---|---|---|
| item* | string | The exact thing being bought; for kind='domain', the full domain name. |
| kind* | string | What is being bought. Only 'domain' is available in chat today. |
| consent_item* | string | The item the customer agreed to buy, as they understood it. If it does not match what is being charged, the charge is REFUSED. |
| consent_confirmed* | string | Pass 'user_confirmed' ONLY after the customer has explicitly agreed to this exact purchase and amount in the conversation. Do not set it on your own initiative. |
| consent_statement* | string | The customer's own words agreeing to this purchase, relayed verbatim. Must mention the item or the price. Do not invent it — if the customer has not explicitly agreed to this amount, do not call this tool. |
Creates the one Stripe Checkout link that pays for a domain registration and saves the card of the customer, so every later purchase can happen inside this conversation. This is the only time the user leaves the chat - give them the returned URL. Reach for this only after they have asked to publish. A refused or unchecked domain ending carries `reason` and a plain `reason_text`: unsupported or price_unavailable mean we do not sell that ending right now; lookup_failed or cap_reached mean it was NOT checked, so search again, and never tell the customer we do not sell it.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The full domain to buy, e.g. example.com. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The full domain to buy, e.g. example.com."
}
},
"additionalProperties": false
}Reviewer token only. Records pass or revise for one exact version of a site (from list_reviews). The operator token can publish only a version whose latest review is a pass; any edit makes a new version.
| Argument | Type | Description |
|---|---|---|
| note | string | Optional summary of the review (up to 2000 characters). |
| items | array | What must change (up to 50 short items). Required in practice for revise. |
| verdict* | string | pass lets the operator publish this exact version; revise blocks it until a new version passes. |
| version* | string | The exact version you reviewed: current_draft_version (before publish_site) or current_staged_version (before publish_staged) from list_reviews. Any later edit makes a new version that needs its own review. |
| site_key* | string | The site you reviewed. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key",
"version",
"verdict"
],
"properties": {
"note": {
"type": "string",
"description": "Optional summary of the review (up to 2000 characters)."
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "What must change (up to 50 short items). Required in practice for revise."
},
"verdict": {
"enum": [
"pass",
"revise"
],
"type": "string",
"description": "pass lets the operator publish this exact version; revise blocks it until a new version passes."
},
"version": {
"type": "string",
"description": "The exact version you reviewed: current_draft_version (before publish_site) or current_staged_version (before publish_staged) from list_reviews. Any later edit makes a new version that needs its own review."
},
"site_key": {
"type": "string",
"description": "The site you reviewed."
}
},
"additionalProperties": false
}Removes one page (not the home page) from your site, using the dashboard's recoverable delete: a version is saved first and the page can be restored. Signed-in accounts only. Free.
| Argument | Type | Description |
|---|---|---|
| path* | string | The page to remove, e.g. "/about". The home page cannot be removed. |
| site_key* | string | The site to remove a page from. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key",
"path"
],
"properties": {
"path": {
"type": "string",
"description": "The page to remove, e.g. \"/about\". The home page cannot be removed."
},
"site_key": {
"type": "string",
"description": "The site to remove a page from."
}
},
"additionalProperties": false
}Changes a site's display name (shown in list_sites and the dashboard). Plain text; HTML entities like ' are decoded. Max 120 characters. Signed-in accounts only. Free.
| Argument | Type | Description |
|---|---|---|
| name | string | The new display name, plain text, e.g. "Pappy's Place". HTML entities are decoded. Max 120 characters. One of name / page_title is required; page_title alone retitles the home page without renaming the site. |
| stage | boolean | true = put the home page title change on the staged copy (publish_staged makes it live). The operator token always stages on a published site. |
| site_key | string | The site to rename. Defaults to the caller's current draft site when omitted. |
| page_title | string | Optional browser-tab / search title for the home page (max 70 characters). Without it, a default home title such as "My Page" (or the old site name) is replaced by the new name; a custom title is kept. |
| og_image_url | string | Optional link-preview (share card) image for the home page: an https:// image URL, max 500 characters. Without it, the first image on the page is used. |
| page_description | string | Optional search-snippet and link-preview description for the home page, 1-300 characters. Write a sentence that makes sense on its own (it is shown out of context). Without it, the first text on the page is used. |
Re-imports ONE page (the home page too) from new HTML, in place: same address, same share link, same place in the page order, and a version is saved first so it can be undone. Use it to refresh a page built earlier. stage:true previews it before it goes live. Free.
| Argument | Type | Description |
|---|---|---|
| html* | string | The new full HTML for this page, imported exactly like create_site_from_html (the result includes the import report). The page keeps its address, its place in the page order and its version history; a version is saved first. |
| path | string | The page to replace, e.g. "/about". "/" (the home page) is allowed. Defaults to "/". |
| stage | boolean | true = replace a staged copy instead of the live page: preview it at staged_preview_url, then publish_staged or discard_staged. Required with the operator token on a live site. |
| site_key | string | The site the page belongs to. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
| keep_added_sections | boolean | true = keep the sections added with add_section (reviews, map and the like) after the imported content, in their original order. Default false: the page is replaced and the result lists them in dropped_sections with a warning (an empty list means none were dropped). |
Puts a site back to a version from list_versions - the undo button for AI edits. The current page is saved as a version first, so a restore can itself be undone. Free, and no account is needed for a draft you created.
| Argument | Type | Description |
|---|---|---|
| page | string | Which page of the site, as its path ("/about", "/contact"). Omit for the home page. See list_pages. |
| site_key | string | The site to restore. Defaults to the caller's current draft site when omitted. |
| version_id* | integer | The version to restore, from list_versions. The current page is saved as a version first, so a restore can itself be undone. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"version_id"
],
"properties": {
"page": {
"type": "string",
"description": "Which page of the site, as its path (\"/about\", \"/contact\"). Omit for the home page. See list_pages."
},
"site_key": {
"type": "string",
"description": "The site to restore. Defaults to the caller's current draft site when omitted."
},
"version_id": {
"type": "integer",
"description": "The version to restore, from list_versions. The current page is saved as a version first, so a restore can itself be undone."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}Saves who a site is for and where things stand: business name, contact name/email/phone, the source pages its facts came from, status (prospect, pitched, managed, declined, transferred_out) and notes. Only the fields you pass change; null clears one. list_sites shows each site's record.
| Argument | Type | Description |
|---|---|---|
| notes | string | Free-text notes (max 5000 chars). Null clears them. |
| status | string | Where the relationship stands. |
| site_key | string | The site the record is about. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
| source_urls | array | The business's own pages the site's facts came from (http/https, max 20). Replaces the stored list. |
| contact_name | string | The person to talk to at the business. Null clears it. |
| business_name | string | The client business name. Null clears it. |
| contact_email | string | Their email. Null clears it. |
Repaints the palette and fonts of an existing site across every section without touching its content or structure - the tool for make it warmer, darker, more corporate. At least one of palette_primary, palette_neutral, font_heading, font_body is required. Free, and no account is needed for a draft you created.
| Argument | Type | Description |
|---|---|---|
| stage | boolean | true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit. |
| site_key | string | The site to theme. Defaults to the caller's current draft site when omitted. |
| font_body | string | New body font family name. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
| favicon_url | string | The browser-tab icon for the site: an https:// image URL (or a /path on the site), max 500 characters. May be the only field. Without one, customer domains show the first letter of the site name on its primary colour. |
| font_heading | string | New heading font family name. |
| palette_neutral | string | New neutral text/background colour as a #rrggbb hex string. |
Page views and unique visitors per day for a published site, plus its top pages and the websites that sent visitors. Counted on the server with no cookies; search bots, previews and Pagetool's own checks are not counted. days defaults to 30 (max 90). Free.
| Argument | Type | Description |
|---|---|---|
| days | integer | How many days back, including today (UTC). Default 30, max 90. |
| site_key | string | The site whose visits to read. Must be yours (or granted to the operator token). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"days": {
"type": "integer",
"description": "How many days back, including today (UTC). Default 30, max 90."
},
"site_key": {
"type": "string",
"description": "The site whose visits to read. Must be yours (or granted to the operator token)."
}
},
"additionalProperties": false
}Declares a built-in form on a site you own: its fields (text, email, textarea, checkbox, month, date, tel, select), the recipient email (kept on the server, never in the page), the button label and the thank-you message. Entries are saved and emailed from Pagetool, behind Turnstile, a honeypot, a minimum fill time, rate limits and field validation. Returns form_key and placeholder_html: put placeholder_html in the page HTML where the form should appear (replace_page_html, or stage then publish_staged). Pass form_key to update an existing form. For any date or month question use a month/date field here (past dates are never offered, and recurring events via occurs drop off once they pass) rather than a raw <input type="date"> in page HTML, which the server cannot check. Free.
| Argument | Type | Description |
|---|---|---|
| name* | string | The form's name, used in the notification subject "<Site name>: new <name>", e.g. "Open mic sign-up". 1-120 characters. |
| stage | boolean | true = stage this form change with the page: visitors keep the live form until publish_staged (discard_staged drops it); preview at staged_preview_url. The operator token always stages on a published site. Omit for an immediately live change. |
| fields* | array | 1-20 fields, in display order. |
| classes | object | Optional Tailwind/CSS class strings to style the form to match the page. |
| form_key | string | Omit to create a new form; pass an existing form_key (from a previous call) to update that form. |
Reports who the caller currently is: an authenticated account, an anonymous draft holder, or nobody. Never errors on absent credentials. You do not need to call this before building - building needs no identity at all.
| Argument | Type | Description |
|---|---|---|
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 17, 2026.
| position |
| integer |
| 0-based slot among the top-level sections (indexes as in list_sections order). Omit to add at the end, just before the footer if there is one. |
| site_key | string | The site to add to. Defaults to the caller's current draft site when omitted. |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
| content_json | any | This section's content, as a JSON string or an object, with the same keys as create_site_from_brief's content_json uses for this kind (e.g. menu: {"heading": "Menu", "items": [{"title": "Latte", "price": "$4", "group": "Drinks"}]}). contact also takes "email", "phone" and "address" (email renders as a mailto link); header and footer take "business_name" for the brand. Omit for honest [add your ...] placeholders. Ignored keys are reported in warnings. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"html": {
"type": "string",
"description": "Instead of kind: your own markup for the new section(s), e.g. \"<section>...</section>\" with its own <style>. Imported like create_site_from_html (the result includes its import report). Best for sites built from HTML. Give kind or html, not both."
},
"kind": {
"enum": [
"hero",
"about",
"services",
"features",
"gallery",
"testimonials",
"pricing",
"faq",
"hours",
"contact",
"cta",
"footer",
"menu",
"map",
"social",
"header",
"products",
"reviews"
],
"type": "string",
"description": "The kind of section to add: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews."
},
"page": {
"type": "string",
"description": "Which page of the site, as its path (\"/about\", \"/contact\"). Omit for the home page. See list_pages."
},
"stage": {
"type": "boolean",
"description": "true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit."
},
"colors": {
"type": "object",
"description": "Optional, for kind \"map\" only. Colours for the new map as 6-digit hex like #1a1a1a: background, text, accent (the link). Leave out to match the section next to it on an imported page.",
"additionalProperties": {}
},
"position": {
"type": "integer",
"description": "0-based slot among the top-level sections (indexes as in list_sections order). Omit to add at the end, just before the footer if there is one."
},
"site_key": {
"type": "string",
"description": "The site to add to. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
},
"content_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": {}
}
],
"description": "This section's content, as a JSON string or an object, with the same keys as create_site_from_brief's content_json uses for this kind (e.g. menu: {\"heading\": \"Menu\", \"items\": [{\"title\": \"Latte\", \"price\": \"$4\", \"group\": \"Drinks\"}]}). contact also takes \"email\", \"phone\" and \"address\" (email renders as a mailto link); header and footer take \"business_name\" for the brand. Omit for honest [add your ...] placeholders. Ignored keys are reported in warnings."
}
},
"additionalProperties": false
}| The business name shown on the pay page. |
| contact_email | string | The business owner's email, for your records (Stripe also collects it at payment). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key",
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain to register for them, bare, e.g. \"joesbakery.com\". Must be available; .com/.net/.org and other Cloudflare endings for now."
},
"dry_run": {
"type": "boolean",
"description": "true = quote only: runs every check and returns price, setup fee and registrar, but creates NO pay link."
},
"interval": {
"enum": [
"month",
"year"
],
"type": "string",
"description": "Billing interval. Defaults to month."
},
"site_key": {
"type": "string",
"description": "The site the business is paying for (must be yours, and not yet live on a domain)."
},
"price_cents": {
"type": "integer",
"description": "Custom price in cents per interval. Omit for the default ($25/month). Required when the domain costs more than $20/year."
},
"business_name": {
"type": "string",
"description": "The business name shown on the pay page."
},
"contact_email": {
"type": "string",
"description": "The business owner's email, for your records (Stripe also collects it at payment)."
}
},
"additionalProperties": false
}| Optional display name for the site row (defaults to business_name). |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
| content_json | any | Per-section content, keyed by section kind (the kind must also be in sections), as a JSON string or an object, max 64KB. Keys per kind - hero: heading, body, ctaLabel, ctaHref, image, alt. about: heading, body, image, alt. cta: heading, body, ctaLabel, ctaHref. services / features / testimonials: heading, items[] of {title, body, href, linkLabel, image, alt}. pricing: heading, items[] of {title, body, price, href, linkLabel, image, alt}. gallery: heading, items[] of {image, alt, title}. faq: heading, items[] of {title, body} (question/q and answer/a are accepted for title/body). hours: heading, body. contact: heading, body. footer: none. menu: heading, items[] of {title, body, price, group} (grouped by group). map: heading, address (defaults to contact_address; embeds a Google map). social: heading, items[] of {title, href}. products: heading, items[] of {title, body, price, href, linkLabel, image, alt, soldOut} (a shop grid: photo, name, price and a Buy now button; soldOut true shows a Sold out badge instead of the button). reviews: heading, placeId (the business Google place id; live reviews show on Creator plans and up, at most 5, fetched from Google at view time; never write review text). header: none (a new site and a new page always start with one: the business name plus links to its sections). An item href renders a link (text = linkLabel, default "Learn more"; in pricing a button, default "Buy now"). Hrefs may be http(s), mailto:, tel:, /path or an in-page anchor like #pricing (every section gets its kind as its id). An image renders a photo with alt - use import_image first to get a hosted copy. Max 12 items per kind. Anything ignored, cut or dropped is listed in the response warnings array - read it. Example: {"hero":{"heading":"Fresh bread daily","body":"Baked before sunrise.","ctaLabel":"Order now","ctaHref":"/order"},"services":{"items":[{"title":"Sourdough","body":"24-hour ferment."},{"title":"Croissants","body":"All butter."}]}} |
| font_heading | string | Heading font family name. Defaults to Inter. |
| business_name* | string | The business or site name. Required, max 120 chars. |
| contact_email | string | Contact email shown in the contact section, if included. |
| contact_phone | string | Contact phone shown in the contact section, if included. |
| contact_address | string | Contact address shown in the contact section, if included. |
| palette_neutral | string | Neutral text/background colour as a #rrggbb hex string. Defaults to #0f172a. |
| palette_primary | string | Primary brand colour as a #rrggbb hex string. Defaults to #2563eb. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"business_name"
],
"properties": {
"tagline": {
"type": "string",
"description": "Short tagline/subheading, max 200 chars."
},
"sections": {
"type": "string",
"description": "Comma-separated section kinds to include, in order, e.g. \"hero,about,services,contact\". Allowed values: hero, about, services, features, gallery, testimonials, pricing, faq, hours, contact, cta, footer, menu, map, social, header, products, reviews. Defaults to hero,about,services,contact when omitted."
},
"template": {
"enum": [
"storefront",
"event",
"shop",
"services",
"nonprofit"
],
"type": "string",
"description": "Optional starter template - the same ones people pick in the editor. storefront: products with buy buttons, why-us, shipping FAQ. event: a recurring night - what to expect, rules, sign-up, where. shop: a place to visit - story, hours, photos, map, socials. services: services with prices, reviews, service area, hours. nonprofit: mission, get involved, give. Your fields win: sections replace the template sections; content_json replaces it per kind, other kinds keep the sample text. business_name is still required."
},
"font_body": {
"type": "string",
"description": "Body font family name. Defaults to Inter."
},
"site_name": {
"type": "string",
"description": "Optional display name for the site row (defaults to business_name)."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
},
"content_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": {}
}
],
"description": "Per-section content, keyed by section kind (the kind must also be in sections), as a JSON string or an object, max 64KB. Keys per kind - hero: heading, body, ctaLabel, ctaHref, image, alt. about: heading, body, image, alt. cta: heading, body, ctaLabel, ctaHref. services / features / testimonials: heading, items[] of {title, body, href, linkLabel, image, alt}. pricing: heading, items[] of {title, body, price, href, linkLabel, image, alt}. gallery: heading, items[] of {image, alt, title}. faq: heading, items[] of {title, body} (question/q and answer/a are accepted for title/body). hours: heading, body. contact: heading, body. footer: none. menu: heading, items[] of {title, body, price, group} (grouped by group). map: heading, address (defaults to contact_address; embeds a Google map). social: heading, items[] of {title, href}. products: heading, items[] of {title, body, price, href, linkLabel, image, alt, soldOut} (a shop grid: photo, name, price and a Buy now button; soldOut true shows a Sold out badge instead of the button). reviews: heading, placeId (the business Google place id; live reviews show on Creator plans and up, at most 5, fetched from Google at view time; never write review text). header: none (a new site and a new page always start with one: the business name plus links to its sections). An item href renders a link (text = linkLabel, default \"Learn more\"; in pricing a button, default \"Buy now\"). Hrefs may be http(s), mailto:, tel:, /path or an in-page anchor like #pricing (every section gets its kind as its id). An image renders a photo with alt - use import_image first to get a hosted copy. Max 12 items per kind. Anything ignored, cut or dropped is listed in the response warnings array - read it. Example: {\"hero\":{\"heading\":\"Fresh bread daily\",\"body\":\"Baked before sunrise.\",\"ctaLabel\":\"Order now\",\"ctaHref\":\"/order\"},\"services\":{\"items\":[{\"title\":\"Sourdough\",\"body\":\"24-hour ferment.\"},{\"title\":\"Croissants\",\"body\":\"All butter.\"}]}}"
},
"font_heading": {
"type": "string",
"description": "Heading font family name. Defaults to Inter."
},
"business_name": {
"type": "string",
"description": "The business or site name. Required, max 120 chars."
},
"contact_email": {
"type": "string",
"description": "Contact email shown in the contact section, if included."
},
"contact_phone": {
"type": "string",
"description": "Contact phone shown in the contact section, if included."
},
"contact_address": {
"type": "string",
"description": "Contact address shown in the contact section, if included."
},
"palette_neutral": {
"type": "string",
"description": "Neutral text/background colour as a #rrggbb hex string. Defaults to #0f172a."
},
"palette_primary": {
"type": "string",
"description": "Primary brand colour as a #rrggbb hex string. Defaults to #2563eb."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"html": {
"type": "string",
"description": "The raw HTML to import. A full document or a bare fragment/section both work. Max 2 MB. Include the page CSS in a <style> block - inline and <style> CSS are mapped to the site styling; external stylesheet links are not fetched. To build several pages at once, pass pages instead."
},
"pages": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "Build a whole site in one call instead of html: a list of up to 10 pages, each { path, html, name? }, exactly one with path \"/\" (the home page), e.g. [{\"path\":\"/\",\"html\":\"...\"},{\"path\":\"/about\",\"html\":\"...\"}]. Link between pages with href=\"/about\". Every page is checked before anything is created."
},
"site_name": {
"type": "string",
"description": "Optional display name for the site (defaults to the document title, or \"Imported site\")."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}| level | integer | New heading level (1-6) when this section is a heading textBox. |
| stage | boolean | true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit. |
| title | string | New title attribute for this section. |
| remove | boolean | When true, removes this section and its descendants instead of editing it (with field "items[n]": removes that one card). |
| content | string | New text content for this section. |
| html_id | string | New HTML id for the node (e.g. "contact" for #contact anchor links). |
| subtype | string | New subtype for this section. |
| add_item | object | Adds one card to the addressed section (services, features, pricing, products, testimonials...), styled like its last card. Fields not given are left out. The response gives its item number. |
| site_key | string | The site to edit. Defaults to the caller's current draft site when omitted. |
| class_name | string | New Tailwind class string for this section. |
| section_id | string | The stable id of the section to address, exactly as list_sections returns it (e.g. "about-1"). It survives removals, unlike index. This ADDRESSES a section; it does not rename anything (use html_id for that). |
| draft_token | string | The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"alt": {
"type": "string",
"description": "New alt text for an image section."
},
"src": {
"type": "string",
"description": "New image/media source (same URL scheme rules as href)."
},
"href": {
"type": "string",
"description": "New link target (http:, https:, mailto:, tel:, a path starting with /, or an in-page anchor like #pricing)."
},
"page": {
"type": "string",
"description": "Which page of the site, as its path (\"/about\", \"/contact\"). Omit for the home page. See list_pages."
},
"field": {
"type": "string",
"description": "Which node inside the addressed section to change, from that section's fields in list_sections: \"heading\", \"body\", \"text[n]\", \"links[n]\", \"image\", \"items[n].title\", \"items[n].body\", \"items[n].price\", \"items[n].link\", \"items[n].image\". A card with no link or photo yet: set field \"items[n].link\" with href (and optional content as the label) or \"items[n].image\" with src, and it is created. \"items[n]\" addresses the whole card (use with remove: true to delete one card). Omit to change the addressed node itself."
},
"index": {
"type": "integer",
"description": "The section (or node) index to edit or remove. Indices SHIFT/renumber whenever an earlier section is removed elsewhere on the page, so an index recorded before a removal may now point at a different section. Prefer section_id; call list_sections first (or after any removal) to get each section's CURRENT index and its stable section_id, which never changes. Give index, section_id, or both (they must agree)."
},
"level": {
"type": "integer",
"description": "New heading level (1-6) when this section is a heading textBox."
},
"stage": {
"type": "boolean",
"description": "true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit."
},
"title": {
"type": "string",
"description": "New title attribute for this section."
},
"remove": {
"type": "boolean",
"description": "When true, removes this section and its descendants instead of editing it (with field \"items[n]\": removes that one card)."
},
"content": {
"type": "string",
"description": "New text content for this section."
},
"html_id": {
"type": "string",
"description": "New HTML id for the node (e.g. \"contact\" for #contact anchor links)."
},
"subtype": {
"type": "string",
"description": "New subtype for this section."
},
"add_item": {
"type": "object",
"description": "Adds one card to the addressed section (services, features, pricing, products, testimonials...), styled like its last card. Fields not given are left out. The response gives its item number.",
"additionalProperties": {}
},
"site_key": {
"type": "string",
"description": "The site to edit. Defaults to the caller's current draft site when omitted."
},
"class_name": {
"type": "string",
"description": "New Tailwind class string for this section."
},
"section_id": {
"type": "string",
"description": "The stable id of the section to address, exactly as list_sections returns it (e.g. \"about-1\"). It survives removals, unlike index. This ADDRESSES a section; it does not rename anything (use html_id for that)."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}| The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"url": {
"type": "string",
"description": "Public http(s) URL of a JPEG, PNG, WebP, GIF or AVIF image (e.g. a photo on the business's own website). Never SVG. Max 10 MB. Give url OR data_base64, not both."
},
"format": {
"enum": [
"webp",
"jpeg"
],
"type": "string",
"description": "Stored format. Default \"webp\" (smallest). Use \"jpeg\" for an image you will set as og_image_url (a link-preview share card), because some preview scrapers do not render WebP."
},
"filename": {
"type": "string",
"description": "Optional original file name, for your own reference; the type is detected from the bytes."
},
"site_key": {
"type": "string",
"description": "The site the image is for; it counts against that site owner's image allowance. Defaults to the caller's current draft site when omitted."
},
"data_base64": {
"type": "string",
"description": "The image itself, base64-encoded (or a data:image/...;base64, URL) - for photos with no public URL, e.g. ones the owner took. Same types and 10 MB limit; downscale large photos before sending. Give url OR data_base64, not both."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
}
},
"additionalProperties": false
}| consent_amount_cents* | integer | The exact amount in cents the customer agreed to pay. If it does not match the real server-side price, the charge is REFUSED and nothing happens. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"kind",
"item",
"consent_confirmed",
"consent_item",
"consent_amount_cents",
"consent_statement"
],
"properties": {
"item": {
"type": "string",
"description": "The exact thing being bought; for kind='domain', the full domain name."
},
"kind": {
"enum": [
"domain"
],
"type": "string",
"description": "What is being bought. Only 'domain' is available in chat today."
},
"consent_item": {
"type": "string",
"description": "The item the customer agreed to buy, as they understood it. If it does not match what is being charged, the charge is REFUSED."
},
"consent_confirmed": {
"enum": [
"user_confirmed"
],
"type": "string",
"description": "Pass 'user_confirmed' ONLY after the customer has explicitly agreed to this exact purchase and amount in the conversation. Do not set it on your own initiative."
},
"consent_statement": {
"type": "string",
"description": "The customer's own words agreeing to this purchase, relayed verbatim. Must mention the item or the price. Do not invent it — if the customer has not explicitly agreed to this amount, do not call this tool."
},
"consent_amount_cents": {
"type": "integer",
"description": "The exact amount in cents the customer agreed to pay. If it does not match the real server-side price, the charge is REFUSED and nothing happens."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "The new display name, plain text, e.g. \"Pappy's Place\". HTML entities are decoded. Max 120 characters. One of name / page_title is required; page_title alone retitles the home page without renaming the site."
},
"stage": {
"type": "boolean",
"description": "true = put the home page title change on the staged copy (publish_staged makes it live). The operator token always stages on a published site."
},
"site_key": {
"type": "string",
"description": "The site to rename. Defaults to the caller's current draft site when omitted."
},
"page_title": {
"type": "string",
"description": "Optional browser-tab / search title for the home page (max 70 characters). Without it, a default home title such as \"My Page\" (or the old site name) is replaced by the new name; a custom title is kept."
},
"og_image_url": {
"type": "string",
"description": "Optional link-preview (share card) image for the home page: an https:// image URL, max 500 characters. Without it, the first image on the page is used."
},
"page_description": {
"type": "string",
"description": "Optional search-snippet and link-preview description for the home page, 1-300 characters. Write a sentence that makes sense on its own (it is shown out of context). Without it, the first text on the page is used."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"html"
],
"properties": {
"html": {
"type": "string",
"description": "The new full HTML for this page, imported exactly like create_site_from_html (the result includes the import report). The page keeps its address, its place in the page order and its version history; a version is saved first."
},
"path": {
"type": "string",
"description": "The page to replace, e.g. \"/about\". \"/\" (the home page) is allowed. Defaults to \"/\"."
},
"stage": {
"type": "boolean",
"description": "true = replace a staged copy instead of the live page: preview it at staged_preview_url, then publish_staged or discard_staged. Required with the operator token on a live site."
},
"site_key": {
"type": "string",
"description": "The site the page belongs to. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
},
"keep_added_sections": {
"type": "boolean",
"description": "true = keep the sections added with add_section (reviews, map and the like) after the imported content, in their original order. Default false: the page is replaced and the result lists them in dropped_sections with a warning (an empty list means none were dropped)."
}
},
"additionalProperties": false
}| contact_phone |
| string |
| Their phone. Null clears it. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"notes": {
"type": "string",
"description": "Free-text notes (max 5000 chars). Null clears them."
},
"status": {
"enum": [
"prospect",
"pitched",
"managed",
"declined",
"transferred_out"
],
"type": "string",
"description": "Where the relationship stands."
},
"site_key": {
"type": "string",
"description": "The site the record is about. Defaults to the caller's current draft site when omitted."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
},
"source_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "The business's own pages the site's facts came from (http/https, max 20). Replaces the stored list."
},
"contact_name": {
"type": "string",
"description": "The person to talk to at the business. Null clears it."
},
"business_name": {
"type": "string",
"description": "The client business name. Null clears it."
},
"contact_email": {
"type": "string",
"description": "Their email. Null clears it."
},
"contact_phone": {
"type": "string",
"description": "Their phone. Null clears it."
}
},
"additionalProperties": false
}| palette_primary | string | New primary brand colour as a #rrggbb hex string. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"stage": {
"type": "boolean",
"description": "true = work on a staged copy instead of the live site: preview it at staged_preview_url, then publish_staged or discard_staged. Omit for a normal (immediately live) edit."
},
"site_key": {
"type": "string",
"description": "The site to theme. Defaults to the caller's current draft site when omitted."
},
"font_body": {
"type": "string",
"description": "New body font family name."
},
"draft_token": {
"type": "string",
"description": "The draft token returned by draft_create, if you are working on an anonymous draft. Only needed when your client cannot send the x-pagetool-draft-token header."
},
"favicon_url": {
"type": "string",
"description": "The browser-tab icon for the site: an https:// image URL (or a /path on the site), max 500 characters. May be the only field. Without one, customer domains show the first letter of the site name on its primary colour."
},
"font_heading": {
"type": "string",
"description": "New heading font family name."
},
"palette_neutral": {
"type": "string",
"description": "New neutral text/background colour as a #rrggbb hex string."
},
"palette_primary": {
"type": "string",
"description": "New primary brand colour as a #rrggbb hex string."
}
},
"additionalProperties": false
}| site_key* |
| string |
| The site the form belongs to. Must be yours. |
| submit_label | string | Button text. Default "Send". Max 60. |
| recipient_email* | string | Where entries are emailed. Stored on the server only; never appears in the page. |
| success_message | string | Shown after a successful entry. Default "Thanks! Your entry was sent." Max 300. May include {field_name} for a text, select, email or tel field, e.g. "Thanks, {name}!" |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site_key",
"name",
"recipient_email",
"fields"
],
"properties": {
"name": {
"type": "string",
"description": "The form's name, used in the notification subject \"<Site name>: new <name>\", e.g. \"Open mic sign-up\". 1-120 characters."
},
"stage": {
"type": "boolean",
"description": "true = stage this form change with the page: visitors keep the live form until publish_staged (discard_staged drops it); preview at staged_preview_url. The operator token always stages on a published site. Omit for an immediately live change."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "1-20 fields, in display order."
},
"classes": {
"type": "object",
"description": "Optional Tailwind/CSS class strings to style the form to match the page.",
"additionalProperties": {}
},
"form_key": {
"type": "string",
"description": "Omit to create a new form; pass an existing form_key (from a previous call) to update that form."
},
"site_key": {
"type": "string",
"description": "The site the form belongs to. Must be yours."
},
"submit_label": {
"type": "string",
"description": "Button text. Default \"Send\". Max 60."
},
"recipient_email": {
"type": "string",
"description": "Where entries are emailed. Stored on the server only; never appears in the page."
},
"success_message": {
"type": "string",
"description": "Shown after a successful entry. Default \"Thanks! Your entry was sent.\" Max 300. May include {field_name} for a text, select, email or tel field, e.g. \"Thanks, {name}!\""
}
},
"additionalProperties": false
}