GitHub: Create a commit

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

Operation github.git_create_commit

Provider route: POST /repos/{owner}/{repo}/git/commits. 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"]["gitCreateCommit"]>[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.gitCreateCommit(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_create_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
`body`	object	Required within parent
`body.author`	object	Optional	Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.
`body.author.date`	string	Optional	Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Format: date-time
`body.author.email`	string	Required within parent	The email of the author (or committer) of the commit
`body.author.name`	string	Required within parent	The name of the author (or committer) of the commit
`body.committer`	object	Optional	Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.
`body.committer.date`	string	Optional	Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Format: date-time
`body.committer.email`	string	Optional	The email of the author (or committer) of the commit
`body.committer.name`	string	Optional	The name of the author (or committer) of the commit
`body.message`	string	Required within parent	The commit message
`body.parents`	array	Optional	The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
`body.parents[]`	string	Each item
`body.signature`	string	Optional	The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.
`body.tree`	string	Required within parent	The SHA of the tree object this commit points to

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_create_commit. Catalog operation: git/create-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