Documentation

Everything you need to build, deploy, and manage AI-powered forms with IdeyForm.

Getting Started

Create your account, generate your first form, and publish it in under 2 minutes.

  1. 1Create an account at /register
  2. 2Navigate to Forms → New Form
  3. 3Give your form a name (e.g. 'Customer Feedback')
  4. 4Write an AI prompt describing your form
  5. 5Click 'Generate Schema' and wait for AI
  6. 6Preview the hosted form and publish

Writing Effective Prompts

Tips for getting the best results from the AI form generator.

  1. 1Be specific about sections and question types
  2. 2Mention if questions should be required or optional
  3. 3Specify scale ranges for rating questions (e.g. 1–10)
  4. 4Include the context or purpose of the form
  5. 5Example: 'Create an employee onboarding form with sections for personal info, emergency contacts, and IT setup preferences. Use checkboxes for equipment selection.'

Schema Versioning

How immutable versioning works and how to iterate on your forms.

  1. 1Every AI generation creates a new schema version (v1.0.0, v1.1.0, ...)
  2. 2Versions are immutable — they never change once created
  3. 3Each version tracks question count and creation date
  4. 4Preview any version via its unique hosted URL
  5. 5Compare versions to see how your form evolved
  6. 6Responses are linked to the specific schema version

Deploying Forms

Deploy your forms to hosted pages, Google Forms, or share via link.

  1. 1Hosted HTML: Every schema version gets a public URL at /f/[schemaId]
  2. 2Share the link directly or embed in an iframe
  3. 3Google Forms: Use the deployment adapter (requires OAuth2 credentials)
  4. 4Publish your form from the detail page to make it live
  5. 5Archive forms to temporarily disable them

Analytics & Responses

Track submissions and analyze response data.

  1. 1View submission timeline for the last 30 days
  2. 2See response counts per schema version
  3. 3Answer distribution shows frequency of each response
  4. 4Select any form from the analytics sidebar
  5. 5All data updates in real time as responses come in

API Reference

Key API endpoints for programmatic access.

  1. 1POST /api/v1/auth/register — Create an account
  2. 2POST /api/v1/auth/login — Get JWT token
  3. 3POST /api/v1/forms — Create a new form
  4. 4POST /api/v1/ai/generate — Queue AI generation
  5. 5GET /api/v1/ai/jobs/:jobId — Poll job status
  6. 6GET /api/v1/public/forms/:schemaId — Get public schema
  7. 7POST /api/v1/public/responses — Submit response
  8. 8GET /api/v1/responses/analytics/:formId — Get analytics

Need more help?

Reach out to our team or check the FAQ.