GitHub: Get details about a codespace export

← Codespaces operations · Get started

Operation github.codespaces_get_export_details_for_authenticated_user

Provider route: GET /user/codespaces/{codespace_name}/exports/{export_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["codespaces"]["codespacesGetExportDetailsForAuthenticatedUser"]>[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.codespaces.codespacesGetExportDetailsForAuthenticatedUser(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.codespaces.codespaces_get_export_details_for_authenticated_user(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.codespace_name	string	Required within parent
path.export_id	string	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 details about a codespace export — response body

Referenced models: Get details about a codespace export — response body

Schemas

Get details about a codespace export — response body

Field	Type	Presence	Description and constraints
$	object	Root	An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest
branch	JSON	Optional
branch (anyOf 1)	string	Alternative	Name of the exported branch
branch (anyOf 2)	null	Alternative
completed_at	JSON	Optional
completed_at (anyOf 1)	string	Alternative	Completion time of the last export operation Format: date-time
completed_at (anyOf 2)	null	Alternative
export_url	string	Optional	Url for fetching export details
html_url	JSON	Optional
html_url (anyOf 1)	string	Alternative	Web url for the exported branch
html_url (anyOf 2)	null	Alternative
id	string	Optional	Id for the export details
sha	JSON	Optional
sha (anyOf 1)	string	Alternative	Git commit SHA of the exported branch
sha (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State of the latest export
state (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.codespaces_get_export_details_for_authenticated_user. Catalog operation: codespaces/get-export-details-for-authenticated-user. 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