On this page
createConsultation
mutation · in the family Consultation
What it does
Create a new consultation — your chat with Aldric; the transcript and its rolling summary are the record at your organization.
Create a Consultation in the caller's org group. Template class (universal staff work — the Scratchpad row's class).
Who may call it
Capability area: Work and notes — Tasks, notes, messages, dashboards and the everyday tools every staff member keeps.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:createConsultation
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
input | NewConsultationInput NewConsultationInput! | yes | No further notes. |
Returns
Consultation Consultation! — A Consultation: the VERBATIM TRANSCRIPT is the record (bounded turn rows — read via consultationTurns) and the MEMORY is the STORED rolling summary ON this record — auditable, purgeable, merchant-visible, never hidden model state. Each ask composes the summary + the last 12 turns verbatim + the asked materials' STORED extractions (EXTRACT-THEN-COMPOSE — raw content is read exactly once, at material confirm). Aldric may attach a DRAFTED PLAN to a reply; TAKING a drafted plan (takeConsultationPlan) mints a Scratchpad through the live spine (origin consultation) and the walk proceeds under the TAKER's own capability (the hardened-Aldric law — the chat holds ZERO mutation authority). Outgrowing the 200-turn transcript refuses HONESTLY naming the cure: a follow-on consultation linked via followOnOfId (never silent middle-loss). USER-parented (the consulter owns the chat), group-rooted. The ops event domain (at.ops.consultation.*).
Example request
mutation ExampleCreateConsultation($input: NewConsultationInput!) {
createConsultation(input: $input) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
turnCount
summary
summarizedThroughSeq
followOnOfId
idleArchiveAt
turnsTierAt
turnsTier
}
}
Variables:
{
"input": {
"caption": "Blue jeans"
}
}
Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.
Example response
{
"data": {
"createConsultation": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "CI-EXMP-0000-000F",
"type": "Consultation",
"caption": "Blue jeans",
"status": "open",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"turnCount": 1,
"summary": "<summary>",
"summarizedThroughSeq": 1,
"followOnOfId": "01900000-0000-7000-8000-7d2662410000",
"idleArchiveAt": "2027-01-31T00:00:00.000Z",
"turnsTierAt": "2027-01-31T00:00:00.000Z",
"turnsTier": "<turns tier>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": {
"name": "genesis",
"number": 0
},
"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)CONFLICT/*— The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)VALIDATION/VERSION_REQUIRED— The request did not say which app version it came from. (VALIDATION)
Dry run
Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.