HOC SiteDocumentation

API

The versioned REST API under /api/v1 for programmatic access to websites, design documents, objects, files, settings, and insights.

The API uses your existing platform account. It does not expose a register route.

POST your email and password to the login endpoint.

POST /api/v1/{locale}/auth/login
{
  "email": "string",
  "password": "string"
}
{
  "accessToken": "string"
}

Send the token on every other call:

Authorization: Bearer <accessToken>

An API key from your account settings works in the same header and does not expire on its own.

How the surface is organized

  • Website-scoped resources live under /api/v1/{locale}/{websiteId}/...: pages, chrome, components, objects, files, settings, access, theme, and insights.
  • Account-scoped resources live under /api/v1/{locale}/... without a website: websites, templates, docs, feedback, and notifications.
  • Catalog resources describe the platform itself: the docs endpoint, the design catalogs, and the endpoint catalog you are reading now.

Every endpoint has a page in API endpoints with its auth, request hints, and the MCP tools that call it. Cross-cutting behavior — errors, pagination, filters, dry runs, cache timing — is in Conventions.