Skip to Content
Getting StartedOverview

Getting Started

ChatBlocks is a schema-first host for AI-generated or agent-generated pages. Your agent sends a page spec, and ChatBlocks handles validation, rendering, storage, routing, and QR generation.

Two creation modes

  1. Manual mode — Send components directly in your JSON spec
  2. Prompt mode — Send a prompt and optional model, and ChatBlocks generates a spec for you

Both modes use POST /api/page-jobs and return a job ID. Poll job status to get the final published URL.

How it works

  1. Create an API key in Settings
  2. Call POST /api/page-jobs with an Idempotency-Key header
  3. Poll GET /api/page-jobs/:jobId until status = succeeded
  4. Receive a live URL like chatblocks.app/yourname/my-page
  5. Optionally set it as your default page (POST /api/pages/:id/default)

Key concepts

  • Page Spec — The JSON contract for every page (reference)
  • Components — 19 typed building blocks (reference)
  • Themes — Presets plus token overrides (reference)
  • Models — Prompt mode model selection per request (gpt-5-mini, gpt-5.2)
  • API Keys — Bearer credentials for programmatic access (details)
  • Agent Connect — One-time account linking flow for agents that need to attach to a signed-in user (guide)

Roadmap note

Agents use API keys for normal API access. The connect-token flow is a separate account-linking handshake for attaching an agent instance to a user account.

Last updated on