reviewRecord

query · in the family Reading your records

What it does

Ask AI to review this record for issues — incomplete, inconsistent, or suspicious-looking values.

Ask AI to review one record for data-quality issues: the model reads the record CONTENT YOU SENT — the same label/value lines the detail page shows (the server reads no tenant data of its own) — and answers a short plain-text review: 2..6 issue lines naming fields that look incomplete, inconsistent, placeholder-like, or suspicious, or exactly 'No issues found.'. READ-ONLY ADVICE — nothing changes on the record. The answer arrives trimmed and bounded 1..2000. type is the record kind word (prompt context only); text is the record content (<= 4000 chars). Refuses INTEGRATION/UNAVAILABLE while the assistant is offline/keyless — review the record by eye. Requires authentication (user sessions). Every made call is cost-metered (at.ai.call.v1).

What happens

A read-only review of what the page already shows: the answer is advice in a popup, nothing changes on the record. It judges only the visible fields and never invents facts. 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:reviewRecord

Arguments

Returns

RecordReview RecordReview! — The record review's answer: a SHORT plain-text issue review of the record content you sent, or exactly 'No issues found.'. READ-ONLY ADVICE — it renders in a popup and changes nothing.

Example request

query ExampleReviewRecord($type: String!, $text: String!) {
  reviewRecord(type: $type, text: $text) {
    review
  }
}

Variables:

{
  "type": "<type>",
  "text": "Restock before the weekend."
}

Example response

{
  "data": {
    "reviewRecord": {
      "review": "<review>"
    }
  },
  "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)