GitHub: Add labels to an issue

GitHub issues.issuesAddLabels: arguments, response, policy and SDK examples.

Operation github.issues_add_labels

Provider route: POST /repos/{owner}/{repo}/issues/{issue_number}/labels. 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["issues"]["issuesAddLabels"]>[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.issues.issuesAddLabels(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.issues.issues_add_labels(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.issue_number`	integer	Required within parent
`body`	JSON	Optional
`body (oneOf 1)`	object	Alternative
`body (oneOf 1).labels`	array	Optional	The labels to add to the issue’s existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use “[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).” Minimum items: 1
`body (oneOf 1).labels[]`	JSON	Each item
`body (oneOf 1).labels[] (oneOf 1)`	string	Alternative
`body (oneOf 1).labels[] (oneOf 2)`	object	Alternative
`body (oneOf 1).labels[] (oneOf 2).confidence`	string	Optional	The confidence level for this label choice. One of: low, medium, high
`body (oneOf 1).labels[] (oneOf 2).name`	string	Required within parent	The name of the label to add.
`body (oneOf 1).labels[] (oneOf 2).rationale`	string	Optional	Optional reasoning for adding this label.
`body (oneOf 1).labels[] (oneOf 2).suggest`	boolean	Optional	If `true`, the label is stored as a pending suggestion for human review rather than applied directly.
`body (oneOf 2)`	array	Alternative
`body (oneOf 2)[]`	string	Each item
`body (oneOf 3)`	array	Alternative
`body (oneOf 3)[]`	object	Each item
`body (oneOf 3)[].confidence`	string	Optional	The confidence level for this label choice. One of: low, medium, high
`body (oneOf 3)[].name`	string	Required within parent
`body (oneOf 3)[].rationale`	string	Optional	Optional reasoning for adding this label.
`body (oneOf 3)[].suggest`	boolean	Optional	If `true`, the label is stored as a pending suggestion for human review rather than applied directly.

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
`$`	array	Root
`$[]`	Model	Each item	Expand Get a label — response body

Referenced models: Get a label — response body

Schemas

Get a label — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
`archived_at`	JSON	Required within parent
`archived_at (anyOf 1)`	string	Alternative	Timestamp indicating when the label was archived, or `null` if it has not been archived. Format: date-time
`archived_at (anyOf 2)`	null	Alternative
`archived_by`	JSON	Required within parent
`archived_by (anyOf 1)`	JSON	Alternative	The user who archived the label, or `null` if it has not been archived.
`archived_by (anyOf 1) (allOf 1)`	Model	All variants apply	Expand List users — response body — item
`archived_by (anyOf 2)`	null	Alternative
`color`	string	Required within parent	6-character hex code, without the leading #, identifying the color
`default`	boolean	Required within parent	Whether this label comes by default in a new repository.
`description`	JSON	Required within parent
`description (anyOf 1)`	string	Alternative	Optional description of the label, such as its purpose.
`description (anyOf 2)`	null	Alternative
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Unique identifier for the label. Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	The name of the label.
`node_id`	string	Required within parent
`url`	string	Required within parent	URL for the label Format: uri

Referenced models: List users — response body — item

List users — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	A GitHub user.
`avatar_url`	string	Required within parent	Format: uri
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative
`email (anyOf 2)`	null	Alternative
`events_url`	string	Required within parent
`followers_url`	string	Required within parent	Format: uri
`following_url`	string	Required within parent
`gists_url`	string	Required within parent
`gravatar_id`	JSON	Required within parent
`gravatar_id (anyOf 1)`	string	Alternative
`gravatar_id (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`login`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`organizations_url`	string	Required within parent	Format: uri
`received_events_url`	string	Required within parent	Format: uri
`repos_url`	string	Required within parent	Format: uri
`site_admin`	boolean	Required within parent
`starred_at`	string	Optional
`starred_url`	string	Required within parent
`subscriptions_url`	string	Required within parent	Format: uri
`type`	string	Required within parent
`url`	string	Required within parent	Format: uri
`user_view_type`	string	Optional

Policy, approvals and errors

SDK function policy ID: github.issues_add_labels. Catalog operation: issues/add-labels. 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