Hostingsurge Builder API
The Builder API from Hostingsurge — 102 operation(s) for builder.
Operations 120
POST
/builder/previews/{sessionId}/wake
Public, no credentials: someone opened a preview link after the preview went to…
#
PATCH
/builder/sessions/{sessionId}
Rename a session, archive it (hidden from the default list, its preview…
#
POST
/builder/sessions/{sessionId}/cancel
Stop the running turn: it ends canceled, the files stay as they were before it…
#
POST
/builder/sessions/{sessionId}/preview/wake
Start the live preview again from the current files after it went idle (answers…
#
POST
/builder/sessions/{sessionId}/preview/keepalive
Someone is looking at the preview: postpone its idle shutdown (call about once…
#
POST
/builder/sessions/{sessionId}/restore
Restore the project to the state right after an earlier turn (recorded as a new…
#
POST
/builder/sessions/{sessionId}/publish
Deploy exactly the version the customer last saw (the session's last commit) to…
#
GET
/builder/sessions/{sessionId}/edits
Live editing: what the editor shows (pages and their sections, theme…
#
POST
/builder/sessions/{sessionId}/edits
Live editing: apply edits made in the preview (text, links, pictures, sections…
#
POST
/builder/sessions/{sessionId}/edits/commit
Live editing: save the pending edits as a version now
#
POST
/builder/sessions/{sessionId}/assets
Upload a picture (JPEG, PNG, WebP, GIF, AVIF or SVG, at most 10 MB) as the…
#
POST
/builder/sessions/{sessionId}/photos/import
Add a free photo from the search to the site's pictures
#
POST
/builder/sessions/{sessionId}/assets/generate
Make a picture with AI from a description (Build Credits); only where AI…
#
POST
/builder/sessions/{sessionId}/turns/{turnId}/bookmark
Bookmark a version as a stable one (or remove the bookmark)
#
POST
/builder/sessions/{sessionId}/preview/version
Show an earlier version in the preview, read-only (turnId null: the current one…
#
GET
/builder/sessions/{sessionId}/content
AI content: languages, pages and their addresses, SEO texts, pictures and what…
#
POST
/builder/sessions/{sessionId}/content/write
AI content: three versions of one text (write, rewrite, shorter, longer…
#
POST
/builder/sessions/{sessionId}/content/improve
AI content: "Improve all texts" of a page or the site, as proposals.
#
POST
/builder/sessions/{sessionId}/content/check
AI content: "Check my texts": spelling, grammar, filler, clichés and claims to…
#
POST
/builder/sessions/{sessionId}/content/seo
AI content: SEO and link-preview texts for pages in one language.
#
POST
/builder/sessions/{sessionId}/content/alt
AI content: alt texts written from the uploaded pictures themselves.
#
GET
/builder/sessions/{sessionId}/content/translations
AI content: the translation table (every text, each language, its state)
#
POST
/builder/sessions/{sessionId}/content/languages
AI content: translate the whole site into one more language (saved as a…
#
DELETE
/builder/sessions/{sessionId}/content/languages/{lang}
AI content: remove a language (saved as a version)
#
POST
/builder/sessions/{sessionId}/content/translations/update
AI content: translate again the texts that need an update (edited ones only…
#
POST
/builder/sessions/{sessionId}/content/translations/keep
AI content: keep translations as they are (up to date)
#
PUT
/builder/sessions/{sessionId}/content/slugs
AI content: a language's page addresses (localized URLs)
#
GET
/builder/sessions/{sessionId}/quality
Site checks: the latest check (six score cards and every finding in plain…
#
POST
/builder/sessions/{sessionId}/quality/checks
Check the site as it is now: the real publish build and its size, every page…
#
PUT
/builder/sessions/{sessionId}/quality/settings
Automatic SEO (every page as real HTML with sitemap.xml, robots.txt, llms.txt…
#
POST
/builder/sessions/{sessionId}/runtime-errors
Runtime errors the live preview reported (the dashboard forwards them): kept…
#
POST
/builder/sessions/{sessionId}/runtime-errors/resolve
Clear the preview's runtime errors (all, or these ids)
#
GET
/builder/sessions/{sessionId}/modes
Agent modes of a session: the mode of recent turns, its plans, the free Chat…
#
PATCH
/builder/sessions/{sessionId}/plans/{planId}
Edit a plan: the whole step list in its new order (tick or untick, rename, add…
#
POST
/builder/sessions/{sessionId}/plans/{planId}/build
Build a plan: marks it building and returns its ticked steps as Build messages…
#
GET
/builder/sessions/{sessionId}/knowledge
"About my business" of this project and the team's guidelines for every site…
#
PUT
/builder/sessions/{sessionId}/knowledge
Save "About my business" (project) and, for owners and admins, the team's…
#
POST
/builder/sessions/{sessionId}/knowledge/propose
Facts about the business the customer stated in this chat that are not saved…
#
POST
/builder/directions
Three design directions (palette, font pairing, hero layout, corners) for a…
#
PUT
/builder/sessions/{sessionId}/look
The look the session's next Build turn applies exactly (colors of both schemes…
#
DELETE
/builder/sessions/{sessionId}/look
Forget the picked look: the next Build turn keeps the site's own look
#
POST
/builder/sessions/{sessionId}/references
Show the builder a picture (PNG, JPEG, WebP, GIF, AVIF, at most 10 MB) or a…
#
GET
/builder/sessions/{sessionId}/references
Pictures and documents shown to the builder this week
#
POST
/builder/sessions/{sessionId}/references/url
A picture of a public web page the customer likes (look and structure only…
#
POST
/builder/sessions/{sessionId}/references/figma
A Figma frame (paste its link) as a picture with its styles.
#
DELETE
/builder/sessions/{sessionId}/references/{referenceId}
Remove a picture or document shown to the builder
#
POST
/builder/figma/connect
Start connecting your Figma account: open connectUrl (valid for 10 minutes)…
#
GET
/builder/figma/callback
Figma sends the member back here after they allowed (or refused) access…
#
GET
/builder/sessions/{sessionId}/backend
The site backend of an AI-built site: collections, forms, sign-in, files, AI…
#
POST
/builder/sessions/{sessionId}/backend/confirm
Apply the waiting steps of backend.json (they remove data, which is kept 30…
#
POST
/builder/sessions/{sessionId}/backend/delete
Delete everything the site stores (members, rows, files, form messages) at once…
#
GET
/builder/sessions/{sessionId}/backend/collections/{collection}/rows
Rows of a collection (every field, private ones too)
#
PATCH
/builder/sessions/{sessionId}/backend/collections/{collection}/rows/{rowId}
Change cells of a row (null clears one)
#
DELETE
/builder/sessions/{sessionId}/backend/collections/{collection}/rows/{rowId}
Delete a row (it can be brought back for 30 days)
#
POST
/builder/sessions/{sessionId}/backend/collections/{collection}/rows/{rowId}/restore
Bring back a deleted row
#
GET
/builder/sessions/{sessionId}/backend/members
The site's members (people with an account on the site)
#
GET
/builder/sessions/{sessionId}/backend/members/test-code
The production smoke test only: the last sign-in code sent to an address (404…
#
PATCH
/builder/sessions/{sessionId}/backend/members/{userId}
Block or unblock a member, or make them a site admin
#
DELETE
/builder/sessions/{sessionId}/backend/members/{userId}
Delete a member's account (their rows stay)
#
POST
/builder/sessions/{sessionId}/backend/members/{userId}/reset
Sign a member out everywhere and remove their password (they sign in with an…
#
POST
/builder/sessions/{sessionId}/backend/files
Add a file (the request body; a picture for an image cell)
#
DELETE
/builder/sessions/{sessionId}/backend/files/{fileId}
Delete a file (it can be brought back for 30 days)
#
GET
/builder/sessions/{sessionId}/backend/submissions.csv
Stored form messages as a CSV file (UTF-8, for spreadsheets)
#
PATCH
/builder/sessions/{sessionId}/backend/submissions/{submissionId}
Mark a message read or unread
#
DELETE
/builder/sessions/{sessionId}/backend/submissions/{submissionId}
Delete a message (it can be brought back for 30 days)
#
POST
/builder/sessions/{sessionId}/backend/submissions/{submissionId}/restore
Bring back a deleted message
#
GET
/builder/sessions/{sessionId}/backend/log
The last calls of the site's visitors to its backend (no addresses, no contents)
#
GET
/builder/sessions/{sessionId}/collab
Draft, GitHub, comments and who is building: the workspace's top bar in one call
#
POST
/builder/sessions/{sessionId}/collab/presence
Tell the others what you look at (page, selected element, view) and what you…
#
GET
/builder/sessions/{sessionId}/code
Every file of the current version, and whether you may edit them
#
PUT
/builder/sessions/{sessionId}/code
Save code changes as one version (0 Build Credits): committed, previewed, then…
#
GET
/builder/sessions/{sessionId}/comments
Comment threads, open ones first (anchors resolved again against the current…
#
POST
/builder/sessions/{sessionId}/comments
Start a thread (pinned to an element or a point of a page) or reply; @name…
#
DELETE
/builder/sessions/{sessionId}/comments/{commentId}
Delete your comment (owners and admins: any)
#
GET
/builder/sessions/{sessionId}/comments/{threadId}/prompt
"Send to AI": the thread as a chat message
#
POST
/builder/sessions/{sessionId}/remix
A copy of the site in a new project (files, never data or orders)
#
POST
/builder/sessions/{sessionId}/org-template
Save the site as a starting point in your team's gallery
#
POST
/builder/org-templates/{templateId}/sessions
Start a new site from one of your team's templates
#
DELETE
/builder/org-templates/{templateId}
Remove a template from the gallery (sites made from it stay)
#
POST
/builder/sessions/{sessionId}/drafts
Try changes in a draft: its own chat, code and preview on a branch; the site…
#
POST
/builder/drafts/{draftId}/keep
Take the draft into the site (one version; lines both changed are finished by…
#
GET
/builder/sessions/{sessionId}/github
The site's GitHub link and whether both sides are in step
#
PUT
/builder/sessions/{sessionId}/github
Keep the site in sync with a repository branch: every version becomes a commit…
#
GET
/builder/sessions/{sessionId}/github/installations
GitHub accounts connected to the team (Settings → Git)
#
POST
/builder/sessions/{sessionId}/github/branch
Follow another branch (the builder takes its code; create: start it from the…
#
POST
/builder/sessions/{sessionId}/github/sync
Sync now (it also happens on every push and every minute)
#
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-builder-visual-op-schema.json
JSONSchema
https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-policy-templates-input-body-schema.json
JSONSchema
https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-pending-changes-input-body-schema.json
JSONSchema
https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-confirm-prices-input-body-schema.json
JSONSchema
https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-collection-input-body-schema.json
JSONSchema
https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-create-shop-input-body-schema.json