Skip to content
For LLMsView as Markdown·

Get the public surfaces manifest ​

http
GET https://api.onehazel.com/onehazel-api/embed/v1/{key}/manifest

Unauthenticated, secret-free description of what an operator's embeddable surfaces can show: live vendors, demo-activated vendors, theme and layout. key is the operator's public embed key (ohpk_..., from the Surfaces page or GET /operators/me/surfaces/embed), never the operator id. The browser Origin must be on the operator's allowed websites list, and the response names that origin in Access-Control-Allow-Origin with Vary: Origin; any other origin, a missing one, or an empty list answers 403 SURFACE_ORIGIN_NOT_ALLOWED. Cacheable privately for 60 seconds, with an ETag. Rate limited per client address. Answers 404 SURFACES_DISABLED while OneHazel Surfaces is not enabled and 404 SURFACE_OPERATOR_UNKNOWN for an unknown or rotated key, an operator id in place of the key, or an account that is not active (all identical).

Section: Surfaces
Operation id: getEmbedV1ByKeyManifest

Authentication ​

No authentication.

Parameters ​

NameInRequiredDescription
keypathyes

Responses ​

200 { "success": true, "data": ... }

Errors return { "success": false, "error": { "code": "...", "message": "..." } } with a 4xx or 5xx status.

Example ​

bash
curl -X GET "https://api.onehazel.com/onehazel-api/embed/v1/{key}/manifest"

Machine-readable: openapi.yaml, openapi.json.