GitHub: Render a Markdown document

← Markdown operations · Get started

Operation github.markdown_render

Provider route: POST /markdown. 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, BackendError, ProviderAPIError } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["markdown"]["markdownRender"]>[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.markdown.markdownRender(input);
    const result = await call.wait();
    if (result.statusCode < 200 || result.statusCode >= 300)
      throw new ProviderAPIError("Provider download failed", result.statusCode);
    if (result.response.bodyTruncated)
      throw new BackendError("Provider download was truncated");
    return result.bodyBytes();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk.exceptions import BackendError, ProviderAPIError
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.markdown.markdown_render(arguments)
        result = await call.wait()
        if not 200 <= result.status_code < 300:
            raise ProviderAPIError("Provider download failed", result.status_code)
        if result.response.body_truncated:
            raise BackendError("Provider download was truncated")
        return result.body_bytes()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent
body.context	string	Optional	The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.
body.mode	string	Optional	The rendering mode. Default: markdown One of: markdown, gfm
body.text	string	Required within parent	The Markdown text to render in HTML.

Response

Response media type: text/html. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	string	Root

Policy, approvals and errors

SDK function policy ID: github.markdown_render. Catalog operation: markdown/render. 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"}

Official provider source