Review a work item's quality
/v1/work-items/{item}/quality-reviews in the Work Items API.
curl -X POST https://api.example.test/v1/work-items/{item}/quality-reviews \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)"Asks Heimdall to read the work item against INVEST, its acceptance criteria, the project's business rules and its sibling items. The review is kept with its findings, the score they leave (100 less 25 per high, 10 per medium and 4 per low finding, never below 0), its band (ready at 80 and above, needs_work from 50, not_ready below) and the version of the work item it read; the call is filed in the AI ledger under the team's monthly budget. Nothing on the work item changes. Answers 201 with the review and emits work_item.quality_reviewed. Read the latest review first: every call spends.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The work item, bound by the middleware.
uuidHeader Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidResponses
201Createdapplication/json
The review, 201.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the token does not carry ai:use, is a client guest's, or the project's assists are off.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
On this endpoint: RESOURCE_NOT_FOUND: when the work item is hidden from the token or missing.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedAI_BUDGET_EXHAUSTEDapplication/json
When the team's monthly AI budget has no room; nothing is filed.
VALIDATION_FAILED: when Heimdall could not reach its model; nothing is filed or written, and a retry a moment later is safe.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on