Skip to content
API docs
Sign inOpen app

Concepts

AI builds and fixes

AI can build a form from a description or fix a draft's errors. While it works, the form's draft is locked.

While AI works

While a build started with POST /v1/forms/generate is planning or building, changing the draft with PATCH /v1/forms/{formId}, publishing and restoring a version answer 409 form_building.

While AI fixes the draft's errors after POST /v1/forms/{formId}/fix, the same calls answer 409 form_fixing.

Follow a build with GET /v1/forms/{formId}/build and a fix with GET /v1/forms/{formId}/fix, and try again once it's over.

What a fix changes

A fix lands as one change to the draft, and only if it leaves fewer errors and no new ones.

It never renames or reuses ids or answer values, and never adds questions or answers. It never removes a step, question, answer or ending that a published version has.

It doesn't publish. You can undo it until the draft changes again or the form is published.

Pictures

When seeing the options helps people answer, a build may ask with pictures, in at most 2 image choice questions. A fix gives a picture to an image choice option that has none, in the form's picture style. Each fix pass covers at most 2 questions with 6 options each.

AI makes these pictures in the background, even after the build or fix is over. Follow them in pictures of GET /v1/forms/{formId}.

Paid checks

AI never turns on a check the workspace can't use, whether its plan or its stage is the reason. See Paid checks.