Review a change
Runs Auditor on a change that is not a pull request yet: the rules pass and a standard deep review over the files you send, answered in one response. The Auditor CLI calls this with your local git changes.
Body
application/json, up to 4 MiB- filesarrayrequired
Up to 60 changed files, each
{ path, base, head }: the file's whole text before and after,nullfor a file that was added or removed. Up to 300,000 characters per side. - titlestringoptional
What the change is for, as a pull request title would say.
- repositorystringoptional
owner/name. When your team uses Auditor on that repository, its settings, team rulesets, documentation facts and learnings apply. - rulesarrayoptional
The repository's
.rules/*.mdfiles as{ path, text }, checked by the rules pass and given to the deep review as conventions, plus itsAGENTS.md,CLAUDE.md,.github/copilot-instructions.mdand.cursor/rules/*files, given to the deep review as coding agent instructions. Up to 80 files.
Response
- idstringrequired
The review's session: its requests are in Logs under
session =this id. - findingsarrayrequired
Highest severity first.
layerisrulesordeep; lines are in theheadtext;suggestionreplaces linesstart_linetolinewhen a fix is mechanical. - estimated_usdstringrequired
Estimated from usage. The settled charges are in Logs.
- notesstring[]required
What the review used or left out, such as documentation sources or a trimmed diff.
- stoppedobject | nullrequired
Set when a pass stopped early after findings were already made. A review that stops with none answers with that error instead, such as
402 insufficient_balance.
Notes
- Billingoptional
Every model call is an ordinary request under the key you send: Directives, budgets and rate limits apply, and each is in Logs. There is no charge for the endpoint itself.
- Depthoptional
Always the standard depth, since there is no repository to explore: three passes over the diff and changed files, a vote, and a verifier. Static analysis does not run.
- Sizeoptional
A change larger than your team's deep review limit (3,000 changed lines by default) answers
400 invalid_request. Review it in parts. - Privacyoptional
The files you send are not stored.