Form API Reference
Every form created in our system automatically generates a RESTful Form API. Use these endpoints to perform headless submissions, evaluate dynamic vibe conditions, or pull submission data into your own backend.
1. Authentication & API Keys
Form submission endpoints are public by default (for client-side forms and ad campaigns), while admin read/management endpoints require your secret API Key header:
2. Generated Submission Endpoint & Vibe Conditions
Submit form entries directly from custom React/Next.js inputs, mobile apps, or headless forms. The system automatically evaluates conditional rules ("vibe conditions") and returns redirect or media actions:
POST /api/v1/submit/{form_id}
Send form payload as JSON along with optional campaign tracking parameters (e.g. utm_source, utm_campaign):
Vibe Condition Response
When a submission triggers a vibe condition (e.g. high budget lead condition), the response payload returns the dynamic action:
{ "success": true, "vibeAction": "SHOW_VIDEO", "videoUrl": "https://...", "redirectUrl": "/thank-you" }3. Fetching Form Schema & Submissions
Pull form fields, vibe condition rules, or submission records programmatically:
GET /api/v1/forms/{form_id}/schema
Retrieves form layout, fields array, and active vibe condition logic rules.
GET /api/v1/forms/{form_id}/submissions
Retrieves collected form submissions including UTM campaign parameters and lead metadata.