Public API

Machine-readable catalog: /.well-known/api-catalog · /openapi.json

HiVideoStudio exposes a small set of public, unauthenticated HTTP endpoints for discovery, health checks, waitlists, and LLM indexes. Agents may call these anonymously.

Public endpoints

MethodPathNotes
GET/api/healthLiveness probe. Returns {"status":"ok"}.
GET/api/auth-configPublic Google client ID for the browser sign-in UI.
POST/api/waitlistJoin an effect waitlist with { toolPageId, email }.
POST/api/preview/first-frameRate-limited free preview stub (no paid model call).
GET/.well-known/api-catalogRFC 9727 API catalog (application/linkset+json).
GET/openapi.jsonOpenAPI 3.1 document for the public endpoints above.
GET/llms.txtCurated plain-text index for LLMs.
GET/auth.mdAgent authentication policy (markdown).

Authenticated actions

Creating videos, checking generation status, reading the library, spending credits, and starting Stripe checkout all require a signed-in human user (Google sign-in on hivideostudio.com). There is no automatic agent registration endpoint and no anonymous account for agents. See /auth.md for the full policy.

Markdown for agents

Public marketing pages (/, effect and model pages, /pricing, /blog) also respond with Content-Type: text/markdown when the request Accept header prefers text/markdown over HTML.