GitHub: Create a tag object

← Git operations · Get started

Operation github.git_create_tag

Provider route: POST /repos/{owner}/{repo}/git/tags. 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"]["gitCreateTag"]>[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.gitCreateTag(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_tag(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.message	string	Required within parent	The tag message.
body.object	string	Required within parent	The SHA of the git object this is tagging.
body.tag	string	Required within parent	The tag’s name. This is typically a version (e.g., “v0.0.1”).
body.tagger	object	Optional	An object with information about the individual creating the tag.
body.tagger.date	string	Optional	When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Format: date-time
body.tagger.email	string	Required within parent	The email of the author of the tag
body.tagger.name	string	Required within parent	The name of the author of the tag
body.type	string	Required within parent	The type of the object we’re tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. One of: commit, tree, blob

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 Get a tag — response body

Referenced models: Get a tag — response body

Schemas

Get a tag — response body

Field	Type	Presence	Description and constraints
$	object	Root	Metadata for a Git tag
message	string	Required within parent	Message describing the purpose of the tag
node_id	string	Required within parent
object	object	Required within parent
object.sha	string	Required within parent
object.type	string	Required within parent
object.url	string	Required within parent	Format: uri
sha	string	Required within parent
tag	string	Required within parent	Name of the tag
tagger	object	Required within parent
tagger.date	string	Required within parent
tagger.email	string	Required within parent
tagger.name	string	Required within parent
url	string	Required within parent	URL for the tag Format: uri
verification	Model	Optional	Expand Get a tag — response body — verification

Referenced models: Get a tag — response body — verification

Get a tag — response body — verification

Field	Type	Presence	Description and constraints
$	object	Root
payload	JSON	Required within parent
payload (anyOf 1)	string	Alternative
payload (anyOf 2)	null	Alternative
reason	string	Required within parent
signature	JSON	Required within parent
signature (anyOf 1)	string	Alternative
signature (anyOf 2)	null	Alternative
verified	boolean	Required within parent
verified_at	JSON	Required within parent
verified_at (anyOf 1)	string	Alternative
verified_at (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.git_create_tag. Catalog operation: git/create-tag. 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