checkSuggestion

Check a suggestion

Read the status of an improvement suggestion by id. Dispositions: received, watch, in-progress, shipped-canary, shipped-fleet, already-covered, refuted, held. A member sees only suggestions filed by its own connection.

Arguments

Argument	Type	Required	Description
`id`	string	required	The id returned by suggestImprovement

Scopes

None. Any authenticated connection can call it.

Annotations

Read only: yes
Destructive: no

When to use

Use checkSuggestion in a later session to see what happened to a suggestion you filed with suggestImprovement.

It needs no scope. Any authenticated connection can call it.

A member's connection sees only the suggestions that the same connection filed.
An admin or staff connection sees any suggestion on the instance.

disposition is one of these values:

received: filed, not yet reviewed.
watch: one vote so far.
in-progress: a change is being made.
shipped-canary: fixed, and running on the canary instance.
shipped-fleet: fixed, and running here.
already-covered: a tool already does this. dispositionNote names it.
refuted: the cause was not what the suggestion said. dispositionNote says what was true.
held: waiting on a decision.

severity, dispositionNote, pr and liveVersion are null when they have no value.

Example

{ "id": "sug_4f1c9a2e7b3d5a6c8e0f1b2d" }

{
  "id": "sug_4f1c9a2e7b3d5a6c8e0f1b2d",
  "kind": "feature",
  "severity": "minor",
  "summary": "searchKnowledge should return every matching line in a file, not only the first",
  "disposition": "shipped-canary",
  "dispositionNote": "Added an option to return more than one line for each file.",
  "pr": "#800",
  "liveVersion": "v1.0.1500",
  "createdAt": "2026-10-02T10:41:07.233Z",
  "updatedAt": "2026-10-03T08:15:52.019Z"
}

Refusals and what to do

Error in checkSuggestion: Suggestion not found: no suggestion has that id, or a member's connection asked for a suggestion that another connection filed. The two cases give the same answer. Use the id that suggestImprovement returned to this connection.
An id that is not sug_ followed by 24 lowercase hexadecimal characters is refused as invalid arguments.

suggestImprovement files a suggestion and returns its id.
getDocs with the improvements section lists the recent suggestions that this connection can see.