Ask what a form request leaves open, before generating from it
Returns up to three questions whose answers would change the form, and **usually returns none**, which is the intended answer rather than a failure. Worth calling when a person is going to see the result: a request that asks to take a payment but names no UPI id, or to branch by plan without naming the plans, produces a form with a hole in it that only they can fill. Feed the answers back as `clarifications` on `POST /v1/ai/generate-form`. Skipping this endpoint entirely is fine; generation does not require it. Runs on the cheapest tier and is not charged as a generation, being a question about a form rather than a form, though its tokens are still counted.
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
curl -X POST "https://example.com/v1/ai/clarify-form" \ -H "Content-Type: application/json" \ -d '{ "prompt": "string" }'{ "questions": [ { "question": "string", "why": "string", "kind": "choice", "options": [ "string" ] } ]}Turn an endpoint on or off. Turning it on clears its failure count
Previous Page
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 request about the form's settings (its colours, the interviewer's tone, a closing date) comes back in `settings`, one entry per setting with its value before and after, already applied to `doc` unless it is marked `locked` because the plan does not include it. A question about how to do something comes back as `answer`, with no `doc`.