Ask a model to change an existing form: add, edit or remove questions and rewire the flow
Returns the proposed document **without saving it** — send it to `PUT /v1/forms/{id}/doc` to keep it. An edit may add no questions at all: most requests about a working form change the routing rather than the wording. Pass `history` (oldest first) when this is a follow-up, or the model cannot resolve 'also', 'it' or 'instead'.
A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/ai/edit-form" \ -H "Content-Type: application/json" \ -d '{ "formId": "string", "prompt": "string" }'Recent delivery attempts, for working out why an endpoint is quiet
Previous Page
Generate a form document from a natural-language prompt
Returns a document and its lint issues **without saving anything** — pass the result to `POST /v1/forms` to keep it. Consumes one `ai_generations` unit and the tokens it costs, charged only when a usable document comes back. If you are already driving this from a model of your own, writing the document yourself and posting it to `/v1/forms` costs you nothing here.