Hyperclay
  1. Hyperclay
  2. Docs
  3. FAQ

FAQ

Answers to common questions about Hyperclay document portability, updates, data sharing, authentication, limits, collaboration, and browser support.

Common questions about how malleable documents, portability, collaboration, and limits work on Hyperclay. For questions about building documents with the ClayJS library, see the ClayJS FAQ.

How long will this be around?#

Hyperclay is built around standard HTML files that save themselves. Those files work as long as web browsers exist. Because you can download your documents at any time or keep them synced to a folder on your computer, your work is never locked into the hosted platform.

What if the service shuts down?#

Every document you create on Hyperclay is a portable HTML file. You can:

How do I update an app?#

You can update a document on Hyperclay in several ways:

  1. In-browser editing: Open the document in your workspace. It opens in view, so choose Return to editing in the document menu (or click Edit on the page, or press ⌘⇧E), then edit content directly through the page’s own interface.
  2. Code editor: Open the code editor beside your document in the workspace to edit its HTML, CSS, and JavaScript.
  3. AI editing: In a document that loads the ai-edit plugin, switch to edit mode, press ⌘J, and describe a change for Hosted AI to make.
  4. Local development: Sync your workspace folder with Hyperclay Local to edit files in your desktop code editor, or import and export HTML files.
  5. Template upgrades: A document copied from a current template (Journal, Kanban or Document) checks for a newer version when someone who can edit it opens it, and offers Upgrade to version <n> in its menu. Your content carries over into the new version.

Every save you make in the browser is recorded in version history, where you can view and restore up to the latest 50 versions.

How do I share data across pages?#

Each document is a self-contained HTML file, and you have several ways to share or combine data across multiple documents:

  • Page data endpoints: Read a document’s tagged content as structured JSON over HTTP, or use the ClayJS data plugin to read and write page data as JSON. See Page data endpoints.
  • Collections: Turn a folder into a public submission intake and queryable collection. See Collections.
  • Multi-page sites: Make a folder a site, and its pages share values such as a name and navigation links from one site.json file. See Multi-page sites.
  • Browser and web APIs: Pass values through URL query parameters, store client-side data in localStorage on the same origin, embed one document inside another with an <iframe>, or fetch data from external APIs.

How do I handle user authentication?#

Hyperclay handles document ownership and workspace permissions (who can view or edit a document), and offers three patterns when your document needs per-user access or state:

  • Workspace sharing and teams: Keep a document private and grant access via a share link, share with a specific person as a viewer or editor, or invite collaborators to a team.
  • Sign-up apps: Enable signups on a public document so visitors can register with a username, email, and password and receive their own isolated, editable copy at their own subdomain. See Sign-up apps.
  • Visitor drafts: Load the ClayJS people and visitor drafts plugin so visitors can edit a public document and keep their changes in their own browser without creating an account. See Free documents for visitors.

What are the performance limits?#

Documents on Hyperclay work within these boundaries:

  • Document size: Each HTML document can be up to 8 MB when saving or importing. (For ⌘J Hosted AI edits, the page must be 400 KB or smaller.)
  • Uploads: Attached files and assets live alongside your documents rather than inside the HTML file. Personal allows uploads up to 20 MB per file (500 MB total), and Maker allows up to 100 MB per file (2 GB total). See Uploads.
  • DOM size and save frequency: In the browser, pages remain responsive up to roughly 100,000 DOM elements. There is no hard cap on how often you save in the browser.
  • Concurrent viewers: Public documents are served as HTML and support unlimited concurrent viewers.

For larger projects, split your project across multiple documents in a folder or read structured data on demand through Page data endpoints. For guidance on what fits a single malleable document, read What ClayJS does not do.

How do I monetize my Hyperclay apps?#

Several approaches work with malleable documents:

  • Direct sales: Sell and distribute your .html or .htmlclay file directly. Buyers can open and save it on their computer with HTML Clay or import it into their own Hyperclay account.
  • Sponsored content: Include sponsorships, affiliate links, or advertisements in a published document.
  • Gated access: Charge for access using an external payment provider, then share a private document or a sign-up app with your customers.
  • Client work: Build custom documents for clients and hand over the HTML file or transfer the document to their Hyperclay account using Move to another account….

Can I collaborate with others?#

Yes. Hyperclay supports three ways to collaborate on documents:

  • Teams: Create a shared workspace for people you work with regularly, with Viewer and Editor roles.
  • Share with a person: Share a single document with another Hyperclay user as a viewer or as an editor so it appears in their workspace.
  • Share links: Create a view link or an edit link for anyone who needs access to one document without joining a team.

When multiple people open the same document, live sync merges their edits in real time, the presence strip shows who else has the document open and who can edit, and collaborators can pin comments and mentions to any part of the page. See Share and collaborate to compare the options.

What browsers are supported?#

Hyperclay works in modern desktop and mobile browsers:

  • Chrome and Edge (Chromium) 90+
  • Firefox 90+
  • Safari 14+
  • Mobile browsers (iOS Safari and Chrome for Android), with a mobile-first workspace layout for managing your files on a phone