GitHub: Create an issue artifact

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

Operation github.issues_create_issue_artifact

Provider route: POST /repos/{owner}/{repo}/issues/{issue_number}/artifacts. 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"]["issuesCreateIssueArtifact"]>[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.issuesCreateIssueArtifact(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_create_issue_artifact(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`	object	Required within parent
`body.body`	string	Required within parent	The artifact content. For `embedded_html` artifacts, provide the HTML source. Minimum length: 1
`body.name`	string	Required within parent	The human-readable name of the artifact. Minimum length: 1
`body.type`	string	Optional	The artifact type. Default: generic One of: generic, link, plan, embedded_html

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 an issue artifact — response body

Referenced models: Create an issue artifact — response body

Schemas

Create an issue artifact — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Issue artifacts are named, typed pieces of content attached to an issue. They give people and agents a durable place to preserve context and supporting material alongside the work. Each artifact has a number unique within the issue.
`body`	string	Required within parent	The artifact content. For `embedded_html` artifacts, this is the HTML source.
`body_html`	JSON	Required within parent
`body_html (anyOf 1)`	string	Alternative	The artifact content rendered as HTML, or `null` if rendering times out or is skipped to protect the response's time budget. The raw content remains available in `body`.
`body_html (anyOf 2)`	null	Alternative
`created_at`	JSON	Required within parent
`created_at (anyOf 1)`	string	Alternative	The time the artifact was created. Format: date-time
`created_at (anyOf 2)`	null	Alternative
`creator`	JSON	Required within parent
`creator (anyOf 1)`	object	Alternative	The user or integration that created the artifact.
`creator (anyOf 1).id`	JSON	Required within parent
`creator (anyOf 1).id (anyOf 1)`	integer	Alternative	Format: int64
`creator (anyOf 1).id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`creator (anyOf 1).login`	string	Required within parent
`creator (anyOf 2)`	null	Alternative
`description`	string	Required within parent	A short, generated summary of the artifact.
`html_url`	string	Optional	The canonical browser URL for the artifact in its issue context. Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The globally unique identifier of the artifact. Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	The human-readable name of the artifact.
`number`	JSON	Required within parent
`number (anyOf 1)`	integer	Alternative	The artifact number within the issue.
`number (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`type`	string	Required within parent	The artifact type. The types supported for external creation and filtering are: - `generic` is a general-purpose Markdown document. - `link` represents a named link. - `plan` is a Markdown plan. - `embedded_html` is a self-contained HTML document. Its `body` contains the HTML source.
`updated_at`	JSON	Required within parent
`updated_at (anyOf 1)`	string	Alternative	The time the artifact was last updated. Format: date-time
`updated_at (anyOf 2)`	null	Alternative
`updated_by_actor`	JSON	Required within parent
`updated_by_actor (anyOf 1)`	object	Alternative	The user or integration that most recently updated the artifact.
`updated_by_actor (anyOf 1).id`	JSON	Required within parent
`updated_by_actor (anyOf 1).id (anyOf 1)`	integer	Alternative	Format: int64
`updated_by_actor (anyOf 1).id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`updated_by_actor (anyOf 1).login`	string	Required within parent
`updated_by_actor (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.issues_create_issue_artifact. Catalog operation: issues/create-issue-artifact. 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