Forms

Try AI autocomplete

POST/v1/forms/{formId}/autocomplete

See the suggestions a visitor would get after typing query into an AI autocomplete question, before you publish. It uses the prompt saved in the draft, so save the draft first. It's never charged, and it shares the cache visitors use. AI-assisted fields are in alpha, so a workspace outside the alpha gets 403 feature_unavailable. A plan without them (entitlements features.aiFields) gets 403 plan_feature. A draft with no AI autocomplete question of that id gets 400 not_autocomplete. Past 300 calls an hour per person or API key, it answers 429 rate_limited.

curl -X POST "$AYEFORM_API/v1/forms/$FORM_ID/autocomplete" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fieldId": "FIELD_ID",
    "query": "Main St"
  }'

200 Response

{
  "suggestions": [
    "…"
  ]
}

Path parameters

formIdstringrequired

Body

JSON, with Content-Type: application/json.

fieldIdstringrequired
The id of the AI autocomplete question in the draft.
1–64 chars
querystringrequired
What the visitor typed.
max 1000 chars

Response

suggestionsarray of stringrequired
Up to 8 suggestions, best first. The list is empty when the query is shorter than 2 characters, the prompt is empty, or the model has nothing or fails.

Errors answer with a status and the error shape.