Getting Started

1. Create an Account

Sign up at app.formr.xyz to get started. You'll be able to create forms, manage submissions, and access your API keys.

2. Get Your API Keys

Navigate to Settings → API Keys in your dashboard to create your keys:

• Publishable keys (pk_live_... or pk_test_...) - Safe for client-side use
• Secret keys (sk_live_... or sk_test_...) - For server-side use only

3. Create Your First Form

Use the dashboard or API to create a form. Here's a simple example:

POST /forms
Authorization: Bearer <your-secret-key>
Content-Type: application/json

{
  "title": "Contact Form",
  "status": "live",
  "environment": "production",
  "fields": [
    {
      "id": "name",
      "type": "text",
      "label": "Your Name",
      "required": true
    },
    {
      "id": "email",
      "type": "email",
      "label": "Email Address",
      "required": true
    },
    {
      "id": "message",
      "type": "textarea",
      "label": "Message",
      "required": true
    }
  ]
}

4. Submit Form Data

Submit data to your form using either client-side or server-side methods:

POST /v1/forms/{formId}/submissions
x-publishable-key: pk_live_...
Content-Type: application/json

{
  "name": "John Doe",
  "email": "john@example.com",
  "message": "Hello!"
}

POST /v1/forms/{formId}/submissions
Authorization: Bearer sk_live_...
Content-Type: application/json

{
  "name": "John Doe",
  "email": "john@example.com",
  "message": "Hello!"
}