Ingest OpenAPI fragment

A machine-readable OpenAPI 3.1 description of the submission endpoint POST /f/:formId is published as a static file. Use it to generate clients or import the endpoint into tools like Postman or Insomnia. For the prose reference, see the Ingest contract.

/ingest-openapi.json (download the full spec)

Scope

This fragment describes only the public ingestion endpoint. It documents:

  • the three accepted request bodies (x-www-form-urlencoded, multipart/form-data, application/json);
  • the 200 AJAX body { ok, id, files }, the classic 302 redirect, and the default HTML thanks page;
  • the error responses 400, 402, 403, 404, 413, 415, 422, and 429 (with its Retry-After header); and
  • the OPTIONS CORS preflight and its Access-Control-Allow-* headers.

The REST API for reading and managing forms and submissions (create/update/delete forms, manage triage) has its own spec at REST API /api/v1/openapi.json.

Ingest OpenAPI fragment | Formward Docs