GitHub: Get an artifact

GitHub actions.actionsGetArtifact: arguments, response, policy and SDK examples.

Operation github.actions_get_artifact

Provider route: GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}. 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["actions"]["actionsGetArtifact"]>[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.actions.actionsGetArtifact(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.actions.actions_get_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.artifact_id`	integer	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 Get an artifact — response body

Referenced models: Get an artifact — response body

Schemas

Get an artifact — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An artifact
`archive_download_url`	string	Required within parent
`created_at`	JSON	Required within parent
`created_at (anyOf 1)`	string	Alternative	Format: date-time
`created_at (anyOf 2)`	null	Alternative
`digest`	JSON	Optional
`digest (anyOf 1)`	string	Alternative	The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.
`digest (anyOf 2)`	null	Alternative
`expired`	boolean	Required within parent	Whether or not the artifact has expired.
`expires_at`	JSON	Required within parent
`expires_at (anyOf 1)`	string	Alternative	Format: date-time
`expires_at (anyOf 2)`	null	Alternative
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	The name of the artifact.
`node_id`	string	Required within parent
`size_in_bytes`	JSON	Required within parent
`size_in_bytes (anyOf 1)`	integer	Alternative	The size in bytes of the artifact.
`size_in_bytes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`updated_at`	JSON	Required within parent
`updated_at (anyOf 1)`	string	Alternative	Format: date-time
`updated_at (anyOf 2)`	null	Alternative
`url`	string	Required within parent
`workflow_run`	JSON	Optional
`workflow_run (anyOf 1)`	object	Alternative
`workflow_run (anyOf 1).head_branch`	string	Optional
`workflow_run (anyOf 1).head_repository_id`	JSON	Optional
`workflow_run (anyOf 1).head_repository_id (anyOf 1)`	integer	Alternative
`workflow_run (anyOf 1).head_repository_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workflow_run (anyOf 1).head_sha`	string	Optional
`workflow_run (anyOf 1).id`	JSON	Optional
`workflow_run (anyOf 1).id (anyOf 1)`	integer	Alternative
`workflow_run (anyOf 1).id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workflow_run (anyOf 1).repository_id`	JSON	Optional
`workflow_run (anyOf 1).repository_id (anyOf 1)`	integer	Alternative
`workflow_run (anyOf 1).repository_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workflow_run (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.actions_get_artifact. Catalog operation: actions/get-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