On this page
summarizeThread
query · in the family Reading your records
What it does
Ask AI for a short synopsis of this record’s note thread — what it is about, what was decided, what still hangs.
Ask AI to summarize one record's note thread: the model reads the THREAD YOU SENT (one line per note — the server reads no tenant data of its own) and answers a short plain-text synopsis: what the thread is about, what was decided, what still hangs — 2..6 lines. A synopsis is not an issues-review (that is reviewRecord). READ-ONLY — nothing changes. Trimmed and bounded 1..2000. type is the record kind word; text is the thread (<= 4000 chars). Refuses INTEGRATION/UNAVAILABLE while the assistant is offline/keyless. Requires authentication (user sessions). Every made call is cost-metered (at.ai.call.v1).
What happens
Read-only advice over the notes already on screen; nothing changes on the record. This is a summary, not a data-quality review (that is the record review).
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:summarizeThread
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
type | String String! | yes | No further notes. |
text | String String! | yes | No further notes. |
Returns
ThreadSummary ThreadSummary! — The thread-summary answer: the synopsis of the thread YOU sent — advice words, nothing changes.
Example request
query ExampleSummarizeThread($type: String!, $text: String!) {
summarizeThread(type: $type, text: $text) {
summary
}
}
Variables:
{
"type": "<type>",
"text": "Restock before the weekend."
}
Example response
{
"data": {
"summarizeThread": {
"summary": "<summary>"
}
},
"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)