API & SDK

Build anything on top of the platform

A clean, modern API and SDKs for frontend and backend workflows.

Read the docsGet started

API features

RESTful endpoints

Typed responses

Fast ingestion

Clear validation

Environment-scoped keys

Developer tools

Playground

CLI

Examples

Developer experience

Simple API, predictable responses. Full TypeScript support. CLI for local development. Everything you need to build forms faster.

Quick start example:

POST /v1/forms
Headers:
Authorization: Bearer sk_live_...
Body:
{
"name": "Contact Form",
"fields": [...]
}

API capabilities:

• Form management (CRUD)
• Submission handling
• Analytics queries
• Webhook configuration
• Environment management
• Full TypeScript types

Read the API documentation

Why it matters

Building form infrastructure from scratch is time-consuming and error-prone. Our API handles validation, storage, delivery, and scale so you can focus on your product. RESTful endpoints, typed responses, and comprehensive documentation.

RESTful endpoints with predictable responses

Full TypeScript support and types

Fast ingestion with clear validation

Environment-scoped keys for security

Comprehensive documentation and examples

API documentation

Start building

Get started with our clean, modern API and SDKs for frontend and backend workflows.

FAQ

The API supports two authentication methods: session tokens (for dashboard operations) and API keys (for programmatic access). API keys come in two types: publishable keys (pk_live_... or pk_test_...) for client-side use, and secret keys (sk_live_... or sk_test_...) for server-side use.

Most API endpoints require or accept an environment parameter (development, staging, production). This ensures complete data isolation—operations in one environment don't affect others. All data is scoped to workspace environments at the storage layer.

Public endpoints are rate limited by IP address, while authenticated endpoints are rate limited by user. Rate limit headers (Retry-After) indicate when you can retry. The API also enforces monthly submission quotas per workspace environment.

Yes, you can include an X-Idempotency-Key header with a unique value to ensure requests are only processed once. This is especially useful for submission endpoints where duplicate processing could cause issues.

Form Platform provides a universal JavaScript/TypeScript SDK (formr) that works in Node.js, Edge runtimes, and browsers. We also provide React components (formr-ui) and a CLI tool (formr-cli) for development. All SDKs include full TypeScript support.