# explainWizardStep

query · in the family [Reading your records](/reference/reading-your-records/)

## What it does

Ask AI to explain where you are on this wizard page — what is happening, what you have provided, and what is still needed and why.

Ask AI to explain where you are on ONE wizard/form step: the model reads what YOU SENT — FILLED (the step's answered label: value lines; EMPTY is lawful: the first-page press) and WANT (one line per empty field) — the server reads no tenant data of its own — and narrates what this step is doing, what you have provided, and what is still needed and WHY each missing piece matters. GUIDANCE ONLY — nothing applies, fills, or changes (the fill assist is suggestFormFill). `type` is the record kind word (prompt context only, 1..64); `step` the page word (1..120); `filled` 0..4000 chars; `want` 0..2000 chars; `materialIds` composes YOUR OWN confirmed materials' stored extractions exactly as on suggestFormFill (≤4, same type word, never a raw re-read). Refuses INTEGRATION/UNAVAILABLE while the assistant is offline/keyless — the page's static guide words still stand. Requires authentication (user sessions). Every made call is cost-metered (at.ai.call.v1).

## What happens

Guidance only: the explanation reads what you already see on the page and narrates it back — nothing is changed, filled, or saved. 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:explainWizardStep`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `type` | [String](/types/#scalars) `String!` | yes | No further notes. |
| `step` | [String](/types/#scalars) `String!` | yes | No further notes. |
| `filled` | [String](/types/#scalars) `String!` | yes | No further notes. |
| `want` | [String](/types/#scalars) `String!` | yes | No further notes. |
| `materialIds` | [ID](/types/#scalars) `[ID!]` | no | No further notes. |

## Returns

[StepExplanation](/types/StepExplanation/) `StepExplanation!` — The responsive guide's answer: what this step is doing, what you have provided, what is still needed and why. GUIDANCE ONLY — rendered verbatim beside the page's static words; nothing applies or changes.

## Example request

```graphql
query ExampleExplainWizardStep($type: String!, $step: String!, $filled: String!, $want: String!, $materialIds: [ID!]) {
  explainWizardStep(type: $type, step: $step, filled: $filled, want: $want, materialIds: $materialIds) {
    explanation
  }
}
```

Variables:

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

## Example response

```json
{
  "data": {
    "explainWizardStep": {
      "explanation": "<explanation>"
    }
  },
  "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](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))