Guides

Home / Documentation / Overview

Documentation

SlateHut is a hosted site builder with a dashboard editor and a versioned REST API. This page explains how the pieces fit together; the separate API reference lists every route, schema, and example.

Welcome

Most teams start in the product: pick a template, edit sections, connect a domain, and collect form responses in one place. When you are ready to automate—or to drive the same data from scripts, CI, or an assistant—you use the API on the same host as your marketing site.

There is no parallel "integration schema": the JSON you read and write through the API matches what the editor saves for a site.

Key concepts

Workspaces

API keys and signed-in browser sessions belong to an active workspace. Switching workspace in the dashboard changes which sites, billing plan, and AI credit pool your requests see. GET /api/v1/sites only returns sites for that workspace.

Sites, pages, blocks

A site has pages; each page has an ordered list of blocks (hero, features, form, footer, animated sections, and so on). The home page is addressed with the path segment _ in API URLs. Nested routes use a single encoded path segment (for example legal%2Fprivacy). Optional per-block animation in the JSON drives entrance motion on the live site; theme fonts are self-hosted on publish for faster loads.

AI generation

You can create a site with a one-shot prompt or a two-step plan flow. Generation consumes the workspace's AI budget in USD; it is not a separate "generation count" product surface. Details and endpoints live in the API reference.

What the API can manage

If you can configure it for a published site in the dashboard, you can usually automate it over HTTP. Editor-only live preview helpers are not exposed.

  • Site & SEO — name, default description, social image, favicon, custom head snippets. CMS detail pages can use pages[].dynamic.seoMapping with {{fieldId}} templates.
  • Look & feel — theme tokens (fonts, colors, spacing, radius) aligned with the editor.
  • Pages & sections — full page CRUD or per-block updates and reorder.
  • Media — uploads and Unsplash import when configured server-side.
  • Forms, CMS, domains — submissions, collections, dynamic pages, custom hostnames. Visitor POST /api/forms/submit and newsletter endpoints count toward plan limits.

Automation & agents

For a concrete sequence (create site → pages → blocks → media → theme → verify), use the step-by-step checklist in the API reference. The examples there include curl, JavaScript, and Python for the same operations.

Open “Build a site (for agents)” in the API reference →

MCP guide: install configs and OAuth vs API keys →

MCP technical notes in the API reference →

Product guides

Resources