GitHub: Run an automation

← Agent automations operations · Get started

Operation github.agent_automations_create_repo_automation_task

Provider route: POST /agents/repos/{owner}/{repo}/automations/{automation_id}/tasks. 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["agentAutomations"]["agentAutomationsCreateRepoAutomationTask"]>[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.agentAutomations.agentAutomationsCreateRepoAutomationTask(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_automations.agent_automations_create_repo_automation_task(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.automation_id	string	Required within parent
body	object	Required within parent	Request body for requesting an automation run.
body.context	string	Optional	Additional context for this automation run, up to 10,000 characters. Supported only when `event` is `manual`. The context supplements the automation’s configured instructions. Maximum length: 10000
body.event	string	Required within parent	The event to trigger. Only `manual` is supported. One of: manual

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	Response from accepting an automation run request.
automation_id	string	Required within parent	The ID of the automation that was triggered.
event	string	Required within parent	The trigger event name, always “manual” for public API runs. Known values: manual
task_id	string	Required within parent	The preallocated ID of the accepted run. The task may not yet be readable, and downstream skips or failures can prevent its creation.

Policy, approvals and errors

SDK function policy ID: github.agent_automations_create_repo_automation_task. Catalog operation: agent-automations/create-repo-automation-task. 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