On this page

suggestFormFill

query · in the family Reading your records

What it does

Ask AI to draft values for the empty inputs on this wizard page, predicted from what you already answered.

Ask AI to draft values for the EMPTY inputs of ONE wizard/form step AND check the answered ones: the model reads what YOU SENT — FILLED (the step's answered label: value lines the merchant already sees) and WANT (one line per empty field: name — label (kind): help; EMPTY = verify-only) — the server reads no tenant data of its own — and answers suggestions ONLY for WANT fields it can predict from FILLED (unpredictable fields are skipped honestly; an empty list is a legal answer) plus advice: a short verification of FILLED (formats · consistency · real-world plausibility — an address's parts must agree; '' = nothing to flag). DRAFTS ONLY — nothing applies or corrects automatically. type is the record kind word (prompt context only, 1..64); step the page word (1..120); filled 1..4000 chars; want 0..2000 chars; materialIds names ≤4 of YOUR OWN confirmed wizard materials on the SAME type word — their stored extractions compose into the model's context (raw content is never re-read; a foreign/mismatched id refuses NOT_FOUND). Refuses INTEGRATION/UNAVAILABLE while the assistant is offline/keyless — fill by hand. Requires authentication (user sessions). Every made call is cost-metered (at.ai.call.v1).

What happens

A drafting assist: suggestions only pre-fill empty boxes for your review — your own answers are never overwritten, and nothing saves until you finish the wizard. It predicts only what it reasonably can and skips the rest. Each use makes one metered AI call.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Owner
System Administrator
Manager
Associate Manager
Warehouse Associate
Sales Associate
An API key whose scope allows api:suggestFormFill

Arguments

Name	Type	Required	Notes
`type`	String `String!`	yes	No further notes.
`step`	String `String!`	yes	No further notes.
`filled`	String `String!`	yes	No further notes.
`want`	String `String!`	yes	No further notes.
`materialIds`	ID `[ID!]`	no	No further notes.

Returns

FormFillSuggestion FormFillSuggestion! — The form-fill assist's answer: drafted values for the empty fields you asked about, name/value pairs the office pre-fills for review, PLUS advice about what you already answered. DRAFTS ONLY — nothing applies automatically; an empty list means nothing was predictable.

Example request

query ExampleSuggestFormFill($type: String!, $step: String!, $filled: String!, $want: String!, $materialIds: [ID!]) {
  suggestFormFill(type: $type, step: $step, filled: $filled, want: $want, materialIds: $materialIds) {
    advice
  }
}

Variables:

{
  "type": "<type>",
  "step": "<step>",
  "filled": "<filled>",
  "want": "<want>",
  "materialIds": [
    "01900000-0000-7000-8000-a36392ca0000"
  ]
}

Example response

{
  "data": {
    "suggestFormFill": {
      "advice": "<advice>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)