Forge requires a connected GitHub account. Start the OAuth flow at
POST /auth/github/start before submitting tasks.Run modes
Choose the mode that matches how much automation you want:Run lifecycle
A Forge run moves through these statuses in order:awaiting_approval step only appears in autonomous mode. In create_pr mode the run goes directly from validating to creating_pr.
Submitting a task
1
Connect GitHub
If you haven’t already, start the GitHub OAuth flow:Open the returned
curl
auth_url in a browser to complete authorization.2
Submit the Forge task
Describe the coding task in plain language and specify the target repository.Response 201:
string
required
Natural language description of the coding task. Up to 5,000 characters.
string
required
The GitHub repository to work in, in
owner/name format.string
default:"autonomous"
Run mode:
analyze_only, generate_patch, autonomous, or create_pr.string
UUID of an existing ManticScore project. Pass
null to leave unattached.array
Optional list of constraints the AI should follow, e.g.
["Do not modify existing tests", "Use the existing logger utility"].3
Stream run progress
Connect to the run’s event stream to watch Forge plan and write code in real time.
curl
Streaming run events
The stream follows the NDJSON v1 protocol.When a tool call fails, Forge emits a
tool_call_failed event with the specific tool name and error before surfacing a generic failure. This makes it easier to diagnose integration issues.Approving or rejecting a run (autonomous mode)
When a run inautonomous mode reaches awaiting_approval, you review the plan and diff before the PR is created.
Approve — create the PR:
curl
curl
curl
curl
Fetching run details and PR info
List all runs
curl
Get a specific run
curl
steps array and an optional pull_request object once the PR has been created.
Get pull request details
curl
Using Forge from a build node
If you have a Build Graph, you can kick off a Forge run directly from any node. ManticScore uses the node’s generated spec as the coding prompt:curl
notes, ManticScore refines the node’s spec with your direction before passing it to Forge.