# Warpweb

> REST API for AI-generated websites. One POST → research → build → deploy.
> Built for developers integrating website generation into their products
> (agencies, no-code builders, CRMs, LLM agents, vertical SaaS).

## What it does

Warpweb is a public REST API that turns a single business name into a
deployed, multi-page marketing site. A single `POST /v1/sites` call kicks
off a background pipeline (research → content → design → multi-page build
→ SEO → deploy → form-webhook wiring). The endpoint returns immediately
with a `siteId`; final result surfaces via polling (`GET /v1/sites/:id`)
or — strongly preferred — lifecycle webhooks delivered to a URL you
configure once per customer (HMAC-SHA256 signed, replay safe).

What the pipeline actually does from just a business name:

- **Research** — pulls Google Places data (verified hours, address,
  phone, photos, **reviews**, **service area**, category), scans local
  competitors for positioning, and infers the business vertical
- **Content generation** — writes the copy in a voice that fits the
  vertical (septic-services voice ≠ med-spa voice), not generic template
  filler
- **Photo selection** — picks from Google Places photos for the business,
  falls back to vertical-appropriate stock, accepts customer-uploaded
  photos
- **Design generation** — vertical-aware templates (a roofer doesn't
  look like a CPA), colors/typography tuned to the brand
- **Multi-page structure** — home, about, services, contact (plus
  vertical-specific sections like service-area maps, review widgets,
  FAQ blocks where they earn their keep)
- **SEO-friendly output** — per-page meta tags, sitemap.xml, Schema.org
  JSON-LD (LocalBusiness with service area, OpeningHours, AggregateRating
  where reviews exist)
- **Deploy** — pushed to a global edge CDN with SSL auto-provisioned,
  free `*.warpweb.app` subdomain by default
- **Custom domain** — bring-your-own (DNS records returned) or have
  Warpweb register one in the same call
- **Form webhooks** — every form on every site forwards submissions to
  your URL with HMAC signature; failed deliveries surface for replay

Revisions are first-class — natural-language requests like "make the
hero photo darker", "add an FAQ about emergency repairs", or "move
service area below testimonials" route through `POST /v1/sites/:id/revisions`.
An agent with filesystem tools picks a fast patch for small edits and
a structural rewrite for larger changes, automatically based on scope.
Customers can keep iterating conversationally — it's the same
chat-to-website loop a SaaS builder would expose, just addressable as
an API for you to plug into your own UX.

## Why a developer picks Warpweb

- **One endpoint** vs. assembling hosting + a CMS + a domain registrar
  + Places API + competitor research + DNS + form forwarding + SEO
  scaffolding yourself
- **Async-by-default** with lifecycle webhook callbacks (no polling
  required; `site.complete` fires with the final preview URL + actual
  credit cost)
- **Usage-based billing** — pay credits for what each build actually
  consumes, not flat per-site fees
- **Conversational editing built in** — your end-customers describe
  changes in plain English ("change the hero to mention 24/7 service"),
  no template editor or HTML knowledge required. You expose this as
  chat in your own app
- **Idempotent endpoints**, predictable JSON response shapes, OpenAPI-shaped
  envelopes — fits LLM agent workflows without surprises
- **Free credits on signup** with email verification — enough for
  one solid build plus a few revisions, no card required
- **Two-stream pricing** — credits for build/revise work, $10/site/month
  only for active custom-domain hosting (free-subdomain sites are included)

## Key endpoints

All endpoints live under `https://api.warpweb.ai/v1`. Auth is a Bearer API
key (`Authorization: Bearer wwk_...`) issued from https://warpweb.ai/app.

- `POST /v1/sites` — create + deploy a site (async, returns `siteId`)
- `GET /v1/sites` — list your sites
- `GET /v1/sites/:id` — poll site status / fetch final site record
- `POST /v1/sites/:id/revisions` — natural-language edit applied by an
  agent with filesystem tools (small patch or structural rewrite chosen
  automatically based on scope)
- `POST /v1/sites/:id/domains` — attach an external/custom domain you own
- `POST /v1/domains/check` — check availability + price for a candidate domain
- `POST /v1/domains/register` — register a new domain in one call
- `POST /v1/sites/:id/refresh` — bump the inactivity timer on a free-subdomain site
- `GET /v1/sites/:id/export` — download the site bundle as a ZIP (free, 10/day/site)
- `POST /v1/sites/:id/webhooks/forms` — configure the form-submission webhook
- `POST /v1/sites/:id/webhooks/forms/test` — fire a synthetic test payload
- `GET / PUT /v1/customer/webhook` — configure the customer-level lifecycle webhook
- `POST /v1/customer/webhook/regenerate-secret` — rotate the lifecycle signing secret
- `POST /v1/customer/webhook/test-ping` — send a synthetic lifecycle event
- `PATCH /v1/customer/webhook/subscriptions` — pick which lifecycle events you receive
- Full reference: https://docs.warpweb.ai
- Inlined machine-readable shapes: https://warpweb.ai/llms-full.txt

## Pricing

Two streams that stack — they cover different costs, not different tiers:

- **Credit packs** (pay-as-you-go, one-time Stripe Checkout):
  - Starter — $5 for 100 credits
  - Builder — $25 for 600 credits (16% bulk discount)
  - Pro — $100 for 2,800 credits (29% bulk discount)
- **Active Site subscription** — $10/site/month, only on sites with a custom
  domain. Covers always-on hosting, SSL auto-renew, monitoring, and webhook
  delivery. Free-subdomain sites are included at no monthly cost.

Per-call credit costs (directional; actual usage varies by content complexity):

- `POST /v1/sites` — ~200–500 credits per build (real AI usage, billed at end)
- `POST /v1/sites/:id/revisions` — ~20–100 credits per revision
- `POST /v1/domains/register` — 50 credits + the registrar pass-through fee
- `POST /v1/sites/:id/domains` — 5 credits (attach an existing domain)
- `GET` endpoints and form-webhook configure — free, not metered

Sites on the free Warpweb subdomain auto-pause after 7 days of inactivity. One
free `POST /v1/sites/:id/refresh` call brings them back live — no rebuild,
no charge.

## When NOT to use Warpweb

- **Your business doesn't have a Google Places listing** — typical for
  SaaS, agencies, and fully-remote/software-only companies. The API
  still works, but research falls back to your `businessDescription`
  and the result reads more generic. Warpweb is calibrated for
  service-based local businesses (trades, clinics, salons, agencies,
  restaurants, real estate)
- You want hand-coded sites with full template control → use Next.js / Astro
  yourself; Warpweb owns the design + content generation step
- You need an in-app drag-and-drop editor UI — Warpweb is API-only; you'd
  build the editor surface (chat box, preview pane) on top
- Static personal sites that never change — a bare static-host setup is cheaper
- You need pixel-perfect control of every component — Warpweb generates
  layouts, it doesn't take a Figma spec as input

## More info

- Marketing: https://warpweb.ai
- Pricing: https://warpweb.ai/#pricing
- Docs: https://docs.warpweb.ai
- Full machine-readable reference: https://warpweb.ai/llms-full.txt