Skip to content
GitmoapAPIBeta
Codediffs
GET/repositories/{repo_id}/commits/{commit_ref}/diff

Get diff for a commit

get_commit_diff
  • diff:read
    A token needs the diff:read scope: View commit, merge-request, and branch-comparison diffsGranted by mcp_agent, mcp_agent_write, read_api, read_repository, write_api, write_repository.Every operation this scope unlocks
  • Metered egress · in band body

    x-gitmoap-egress: {"kind":"metered","arg":"in_band_body"}

  • Cacheable · immutable SHA

    x-gitmoap-cache: {"kind":"immutable_sha"}

The files a commit changes against its first parent — for a root commit, everything it adds — a page at a time in path order, with totals for the whole change. Patches come only with include_patch=true, and a generated or very large file's patch is then withheld as collapsed unless collapse=false; fetch it with the single-file diff. Anyone who can read the repository's code may call it.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository ID
  • commit_refCommitRef (string)Commit SHA (7-40 hex chars)
Query
  • pageintegeroptionalPage number (0-based). Default: 0
  • limitintegeroptionalFiles per page (1-100). Default: 20
  • include_patchbooleanoptionalInclude unified diff patch content. Default: false
  • collapsebooleanoptionalAuto-collapse generated/oversized file patches (fetch them via /diff-file). Default: true

Responses

200Commit diffapplication/json
  • base_shaCommitHash (string)
  • filesarray of DiffFile
    • The DiffFile schema
    • additionsinteger0–∞
    • collapsedbooleanThe patch was intentionally withheld (generated or oversized) to save bytes but is fetchable in full on demand via GET .../diff-file. Only ever set when patches were requested (include_patch=true).
    • deletionsinteger0–∞
    • generatedbooleanDetected generated/lock/minified file. Always computed from the path, independent of collapsed, so a client can badge or auto-fold it.
    • is_binaryboolean
    • patch_truncatedbooleanThe patch exceeds the hard per-file size cap and is omitted. Unlike collapsed, this file is not expandable in place — a client reads it piece-by-piece via GET .../file-lines instead.
    • pathstring
    • statusDiffFileStatusaddedmodifieddeletedrenamedcopied
    • collapse_reasonCollapseReasongeneratedlargeor nulloptionalWhy a file's patch body was withheld from a DiffFile (see collapsed). Distinct from patch_truncated, which marks a patch too large to ever send; a collapsed file's patch is fetchable on demand via GET .../diff-file.
    • old_pathstring or nulloptional
    • patchstring or nulloptional
  • has_morebooleanAnother page follows this one.
  • head_shaCommitHash (string)
  • pageinteger0–∞The page returned, from 0.
  • statsDiffStats
    • The DiffStats schema
    • additionsinteger0–∞Lines added across the whole change.
    • deletionsinteger0–∞Lines deleted across the whole change.
    • files_changedinteger0–∞Every file the change touches.
  • total_filesinteger0–∞How many files the pages can reach — every changed file, unless truncated.
  • truncatedbooleanThe change touches more files than any page can reach. stats still counts all of them.
200 exampleSynthesized example
{
"base_sha": "cc164fcd5c947ea1f173cf1f91adf489fcf92cd1",
"files": [
{
"additions": 39,
"collapsed": false,
"deletions": 14,
"generated": false,
"is_binary": false,
"patch_truncated": false,
"path": "path-1575",
"status": "added"
},
{
"additions": 17,
"collapsed": false,
"deletions": 35,
"generated": false,
"is_binary": false,
"patch_truncated": false,
"path": "path-5232",
"status": "added"
}
],
"has_more": false,
"head_sha": "d5bd4192744caf01ebf46aa8492f86371469e80d",
"page": 63,
"stats": {
"additions": 85,
"deletions": 50,
"files_changed": 45
},
"total_files": 2,
"truncated": false
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-3271",
"message": "Inline scalar newtypes but keep their brand"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-1a5a",
"message": "Inline scalar newtypes but keep their brand"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-d9d3",
"message": "Draw the region map from operation density"
}
}
404Repository or commit not foundapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-6e5d",
"message": "Label every synthesized example"
}
}

CLI

gitmoap diffs get-commit-diff

  • --repo-ididRepository ID (id or owner/repo path)
  • --commit-refidCommit SHA (7-40 hex chars)
  • --collapseflagoptionalAuto-collapse generated/oversized file patches (fetch them via /diff-file). Default: true
  • --include-patchflagoptionalInclude unified diff patch content. Default: false
  • --limitnumberoptionalFiles per page (1-100). Default: 20
  • --pagenumberoptionalPage number (0-based). Default: 0

Used in these guides