GitHub: Get Agent Merge configuration for a pull request

← Agent merge operations · Get started

Operation github.agent_merge_get_agent_merge_enrollment

Provider route: GET /agents/repos/{owner}/{repo}/pulls/{pull_number}/agent-merge. 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["agentMerge"]["agentMergeGetAgentMergeEnrollment"]>[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.agentMerge.agentMergeGetAgentMergeEnrollment(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.agent_merge.agent_merge_get_agent_merge_enrollment(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.pull_number	integer	Required within parent	Format: int64 Minimum: 1

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
$	object	Root	The Agent Merge configuration for an enrolled pull request. Additional keys: not allowed
allowed_actions	array	Required within parent	The set of actions which Copilot may perform on the pull request. Minimum items: 1 Unique items: true
allowed_actions[]	string	Each item	An action that Agent Merge is explicitly allowed to perform. Known values: fix_ci, resolve_merge_conflicts
created_at	string	Required within parent	Timestamp when the pull request was enrolled for Agent Merge. Format: date-time
updated_at	string	Required within parent	Timestamp when the Agent Merge enrollment was last updated. Format: date-time
user	object	Required within parent	The user who most recently enabled Agent Merge for the pull request Additional keys: not allowed
user.id	JSON	Required within parent
user.id (anyOf 1)	integer	Alternative	The unique identifier of the user Format: int64 Minimum: 1
user.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.agent_merge_get_agent_merge_enrollment. Catalog operation: agent-merge/get-agent-merge-enrollment. 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