Forms

Get a form's AI build

GET/v1/forms/{formId}/build

Get the form's latest AI build, or null if it never had one. While a build is planning or building, the draft is locked (see AI builds and fixes). Pictures for its image choice questions are made in the background, even after the build is done. They show up in pictures of GET /v1/forms/{formId}.

curl "$AYEFORM_API/v1/forms/$FORM_ID/build" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "buildId": "69gd4qxa20pqkjk58ftkky35797ttbw4",
  "status": "planning",
  "plan": {
    "name": "Luigi's Pizza",
    "steps": [
      {
        "title": "Luigi's Pizza",
        "questions": [
          "Which crust?"
        ]
      }
    ]
  },
  "added": -9007199254740991,
  "skipped": -9007199254740991,
  "skippedLabels": [
    "…"
  ],
  "total": -9007199254740991,
  "error": null,
  "startedAt": 1790879400000,
  "endedAt": 1790879400000
}

Path parameters

formIdstringrequired
The form's id.

Response

Or null.

buildIdstringrequired
The build's id.
statusenumrequired
planning while AI decides the questions, then building while it adds them to the draft. It ends as done, failed or stopped.
One of "planning", "building", "done", "failed", "stopped"
planone of 2required
The form AI planned, with its name and the questions of each step. Null until the plan is ready.
Show 2 optionsHide 2 options
- Option 1
  - namestringrequired
  - stepsarray of objectrequired
    Show 2 fieldsHide 2 fields
    titlestringrequired
    questionsarray of stringrequired
- null
addedintegerrequired
How many of the total questions are in the draft so far.
-9007199254740991–9007199254740991
skippedintegerrequired
How many questions couldn't be built.
-9007199254740991–9007199254740991
skippedLabelsarray of stringrequired
The labels of the questions that couldn't be built.
totalintegerrequired
How many questions AI planned.
-9007199254740991–9007199254740991
errorstring or nullrequired
Why the build failed. Null unless it failed.
startedAtnumberrequired
endedAtnumber or nullrequired

Errors answer with a status and the error shape.