Analyse a change request's impact
/v1/change-requests/{changeRequest}/analyse in the Change Requests API.
curl -X POST https://api.example.test/v1/change-requests/$CHANGE_REQUEST_ID/analyse \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)"Asks Heimdall to read the request against its baseline and the records it names, each with what links to it. The reading is written as the request's draft (ai_impact_draft: the summary, the scope, the risk, the records touched and the questions to ask before deciding) and fills the impact fields the analyst left empty (the level, the schedule, the effort, the scope and the risk); a number the analyst already wrote is never replaced. A request still only submitted moves under analysis. The call is metered against the team's budget and filed under the impact analysis feature; the save writes a version with the reason ai_assist.
Answers 200 with the request and emits change_request.analysed.
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 request, 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
200OKapplication/json
The request with Heimdall's draft on it.
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 is a client guest's, the project's assists are off, or its holder's role does not carry change-request:analyse and ai:use.
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.
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 month has no room left.
VALIDATION_FAILED: when the provider did not answer.
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