Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gratitude5dee/Zap/llms.txt

Use this file to discover all available pages before exploring further.

Zap’s production target is Vercel with Node 24.x, served at zap.wzrd.tech. The Vercel project is named zap and connects to the wzrdstudio Supabase project. All environment variables documented here belong in Vercel’s project settings; user-level provider keys belong in Supabase (see the Supabase Secrets guide).

​
Prerequisites

Before deploying, confirm you have:
  • Node 24.x installed locally (matches the Vercel runtime)
  • A provisioned Convex project with NEXT_PUBLIC_CONVEX_URL and CONVEX_URL
  • A provisioned Supabase project (wzrdstudio) with the BYOK migration applied
  • An Upstash Redis instance with REST URL and token
  • A Vercel Blob store with a BLOB_READ_WRITE_TOKEN
  • The Vercel CLI installed (npm i -g vercel) and authenticated

​
Deploy Sequence

1

Run pre-deploy checks

Run the full test, type-check, and build suite locally before pushing to production.
npm test && npm run typecheck && npm run build
All three commands must exit 0. Fix any failures before proceeding.
2

Deploy to Vercel

Deploy the production build with the Vercel CLI.
vercel deploy --prod --yes
The CLI will pick up your linked project and push the build to Vercel’s edge network.
3

Attach and verify the custom domain

In the Vercel project dashboard, add zap.wzrd.tech as a custom domain and verify DNS propagation. The domain must resolve before live traffic can be routed correctly.Confirm the domain is active:
curl -I https://zap.wzrd.tech/
Expect a 200 OK (or a redirect) with Vercel’s response headers.
4

Apply Supabase migrations

Run the BYOK migration against the wzrdstudio Supabase project before enabling any live runs that depend on creator-supplied provider keys.
supabase db push --project-ref <your-project-ref>
See the Supabase Secrets guide for the full migration details and required edge function setup.
5

Run smoke tests

Verify the deployment end-to-end:
# Health check
curl -I https://zap.wzrd.tech/

# Confirm API routes are reachable
curl -s https://zap.wzrd.tech/api/health

# Confirm the poll drain endpoint is accessible (should 401 without secret)
curl -I https://zap.wzrd.tech/api/providers/poll/drain
If Basic Auth is enabled, include -u "$ZAP_BASIC_USER:$ZAP_BASIC_PASSWORD" in your curl calls.

​
Environment Variables

Set all of the following in Vercel → Project Settings → Environment Variables for the Production (and optionally Preview) environment.
User-level provider keys (gmi_api_key, fal_key, etc.) belong in Supabase via the BYOK secret store — not in Vercel environment variables. The variables below are app-level credentials only.

​
Supabase

VariableDescription
NEXT_PUBLIC_SUPABASE_URLYour Supabase project URL, e.g. https://<ref>.supabase.co
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEYSupabase publishable (anon) key for client-side auth
NEXT_PUBLIC_SUPABASE_ANON_KEYLegacy alias for the publishable key; use one or the other
NEXT_PUBLIC_THIRDWEB_CLIENT_IDThirdweb client ID used for wallet-based login on the /settings page
ZAP_SECRET_REVEAL_TOKENLong random value shared between Vercel and the zap-user-secrets edge function; authorises server-side plaintext key reveal
ZAP_WALLET_PROOF_FUNCTIONName of the Supabase edge function that handles wallet proof (default: zap-wallet-proof)

​
Convex

VariableDescription
NEXT_PUBLIC_CONVEX_URLPublic Convex deployment URL used by the browser client
CONVEX_URLServer-side Convex URL used by Next.js API routes

​
Upstash Redis

VariableDescription
UPSTASH_REDIS_REST_URLUpstash Redis REST endpoint URL
UPSTASH_REDIS_REST_TOKENUpstash Redis REST token

​
Vercel Blob

VariableDescription
BLOB_READ_WRITE_TOKENVercel Blob store token for asset upload and retrieval

​
App-Level Provider Credentials

These are the Zap server’s own provider credentials, used when ZAP_PROVIDER is set to a real provider (not mock).
VariableDescription
GMI_API_KEYGMI API key for the Zap server account
GMI_ORG_IDGMI organisation ID for the Zap server account
FAL_KEYFal.ai API key for the Zap server account
AI_GATEWAY_API_KEYAPI key for the AI gateway, when routing provider calls through a centralised gateway
ZAP_PROVIDERActive provider mode: mock, gmi, or fal
ZAP_PROVIDER=mock is the safe default and will not call any external provider. Only change this to gmi or fal after confirming the corresponding API keys are correctly configured and tested. Setting a real provider without valid credentials will cause all live runs to fail.

​
Poll Drain

VariableDescription
ZAP_POLL_DRAIN_URLFull URL of the deployed poll drain endpoint, e.g. https://zap.wzrd.tech/api/providers/poll/drain
ZAP_POLL_DRAIN_SECRETShared secret used to authenticate Upstash → Vercel drain requests; set this in both Vercel and Convex
ZAP_SYNC_POLL_INTERVAL_MSPolling interval in milliseconds between provider status checks (default: 5000)
ZAP_SYNC_POLL_TIMEOUT_MSMaximum time in milliseconds to wait for a run to complete before the poller gives up (default: 1200000)

​
Legacy Basic Auth

VariableDescription
ZAP_BASIC_USERHTTP Basic Auth username (default: zap)
ZAP_BASIC_PASSWORDHTTP Basic Auth password — change from the default change-me before going live

Build docs developers (and LLMs) love

Get started for freeTalk to us