Skip to content

Integration Modes

Formerie is designed as a progressive-control platform. Use the raw runtime API when you want complete control, or move up to SDK helpers, framework state, browser mount helpers, embeds, and hosted pages when you want Formerie to handle more of the workflow.

Every mode uses the same public contract:

  • public form schema
  • validation API
  • submission API
  • validation error shape
  • safe metadata model
  • server-managed delivery configuration

This keeps customer choice high without creating separate product behavior for each integration style.

Mode Matrix

ModeStatusCustomer controlsFormerie handles
Raw runtime APIAvailableUI, state, validation display, styling, analytics hooksPublic schema, validation, submission, server delivery
Core SDKAvailableUI, state, styling, analytics hooksURL building, request shape, response parsing, error helpers
Framework headlessInitial packages availableMarkup, field components, styling, layout, page flowFramework state helpers and SDK delegation
Browser mount helpersInitial SDK helpers availableContainer placement and CSSPublic-schema rendering, visibility, submission, validation display
Embed or hosted formInitial runtime availablePlacement, domain, basic themingRuntime, rendering, upgrades, submission, validation, delivery
Generated styled rendererPlannedTheme tokens and content placementComplete accessible form UI, state, submission, validation display
AI Form AssistPlannedUser review, consent, applied suggestionsField help, document extraction, conversational fill, review suggestions

Runtime Routes

The default runtime host is https://forms.formerie.com:

Text
GET  https://forms.formerie.com/{workspaceHandle}/{formHandle}/schema
POST https://forms.formerie.com/{workspaceHandle}/{formHandle}/validate
POST https://forms.formerie.com/{workspaceHandle}/{formHandle}/submit

Workspace-bound customer hostnames use /{formHandle}/schema, /{formHandle}/validate, and /{formHandle}/submit. Form-bound customer hostnames use /schema, /validate, and /submit.

The management API also exposes an API-compatible /v1/{workspaceHandle}/{formHandle} surface on https://api.formerie.com. Hosted forms, customer runtime hostnames, embeds, and SDK runtime examples should use the clean runtime route shape.

Browser SDK

Use @formerie/client when a JavaScript or TypeScript project wants runtime URL builders, public schema loading, typed response shapes, validation helpers, and browser form helpers without exposing private configuration.

TypeScript
import { FormerieRuntimeClient } from "@formerie/client";

const formerie = new FormerieRuntimeClient();

await formerie.submit("example.com", "contact", {
  fields,
  verificationToken
});

The browser mount helpers can load public schema, render a plain DOM form, bind visibility, collect fields, submit to the runtime, and display validation errors. The runtime API still owns authoritative validation, verification, spam checks, routing, delivery, and submission acceptance.

Hosted And Embed

Hosted pages and embeds use the same public schema and submission contract as the raw runtime API and SDK helpers.

HTML
<script src="https://forms.formerie.com/embed.js" data-formerie-form="example/contact"></script>
Text
https://forms.formerie.com/example/contact
https://forms.example.com/contact
https://contact.example.com/

Security Boundary

Public clients submit only field values, verification tokens, and safe metadata. Recipients, provider credentials, templates, delivery rules, provider selection, rate-limit policy, and server-side validation stay configured in Formerie.