Docs/Forms/Getting Started/Quickstart

Quickstart

Provision a form, wire it into your site, and claim it, in three steps.

View as Markdown

Lanes Forms gives you a form backend without building one. Provision an endpoint, point your site at it, and claim it when you are ready. No signup to get started.

1. Provision an endpoint

One POST returns a live endpoint. Only schema is required.

curl
curl -X POST https://api.lanes.sh/v1/forms \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": ["you@company.com"],
    "allowed_origins": ["example.com"],
    "schema": [
      {"name": "email", "type": "email", "required": true},
      {"name": "message", "type": "textarea"}
    ]
  }'

The response includes an endpoint_url to submit to, and either a claim_url or a claim_email_sent_to, depending on whether you passed any recipients. Full detail in Provisioning.

2. Wire it into your site

Point a plain HTML form at the endpoint. On submit, the visitor is redirected to a hosted thank-you page.

index.html
<form action="https://api.lanes.sh/v1/f/YOUR_FORM_ID" method="POST">
  <input type="email" name="email" required />
  <textarea name="message"></textarea>
  <!-- honeypot: bots fill this, humans never see it -->
  <input type="text" name="_gotcha" style="display:none" tabindex="-1" />
  <button type="submit">Send</button>
</form>

Prefer JSON? POST to the same endpoint from fetch or your server and read back { "ok": true, "submission_id": "..." }. See Integrating and Submitting.

3. Claim it

Submissions are captured from the first second and held until you claim the form. Open the claim link (emailed to your first recipient, or returned as claim_url) and sign in. Everything collected so far lands in your dashboard and email forwarding turns on. See Claiming.

Doing it from an agent

If you work through a coding agent, skip the curl entirely. The Lanes MCP server and the lanes-forms skill both provision forms for you:

Agent prompt
Set up form handling for this site using Lanes Forms.
No signup is required.

1. Install the Lanes Forms skill:

   /plugin marketplace add lanes-sh/app
   /plugin install lanes-forms@lanes

2. Then use it to provision a form:

   "Use the lanes-forms skill to provision a form backend for
    submissions to <where submissions should go> from
    <your site domain, e.g. example.com>."

The skill knows the API contract, creates the form, and returns a
live endpoint to point the site at. Submissions are captured from
the first second. The same skill can also fill in a form on your
behalf: give it a live endpoint and the fields to submit.

How the form is claimed depends on how it is provisioned:
- No key: the response always returns a one-time claim_url.
  Hand it to whoever should own the form. If you pass
  recipients, that same link is also emailed to the first
  address, so they can click either one, sign in, and claim
  the form to turn on forwarding.
- With a workspace key (lfk_...): the form is born claimed
  into that workspace, no claim step needed.

More in Agents and MCP.

Next steps