GitHub: Get a commit object

GitHub git.gitGetCommit: arguments, response, policy and SDK examples.

Operation github.git_get_commit

Provider route: GET /repos/{owner}/{repo}/git/commits/{commit_sha}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["git"]["gitGetCommit"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.git.gitGetCommit(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.git.git_get_commit(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`path.commit_sha`	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Create a commit — response body

Referenced models: Create a commit — response body

Schemas

Create a commit — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Low-level Git commit operations within a repository
`author`	object	Required within parent	Identifying information for the git-user
`author.date`	string	Required within parent	Timestamp of the commit Format: date-time
`author.email`	string	Required within parent	Git email address of the user
`author.name`	string	Required within parent	Name of the git user
`committer`	object	Required within parent	Identifying information for the git-user
`committer.date`	string	Required within parent	Timestamp of the commit Format: date-time
`committer.email`	string	Required within parent	Git email address of the user
`committer.name`	string	Required within parent	Name of the git user
`html_url`	string	Required within parent	Format: uri
`message`	string	Required within parent	Message describing the purpose of the commit
`node_id`	string	Required within parent
`parents`	array	Required within parent
`parents[]`	object	Each item
`parents[].html_url`	string	Required within parent	Format: uri
`parents[].sha`	string	Required within parent	SHA for the commit
`parents[].url`	string	Required within parent	Format: uri
`sha`	string	Required within parent	SHA for the commit
`tree`	object	Required within parent
`tree.sha`	string	Required within parent	SHA for the commit
`tree.url`	string	Required within parent	Format: uri
`url`	string	Required within parent	Format: uri
`verification`	object	Required within parent
`verification.payload`	JSON	Required within parent
`verification.payload (anyOf 1)`	string	Alternative
`verification.payload (anyOf 2)`	null	Alternative
`verification.reason`	string	Required within parent
`verification.signature`	JSON	Required within parent
`verification.signature (anyOf 1)`	string	Alternative
`verification.signature (anyOf 2)`	null	Alternative
`verification.verified`	boolean	Required within parent
`verification.verified_at`	JSON	Required within parent
`verification.verified_at (anyOf 1)`	string	Alternative
`verification.verified_at (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.git_get_commit. Catalog operation: git/get-commit. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page