CoderHelm Docs
APIPlans

Approve and run a plan

POST
/api/plans/{plan_id}/approve-and-execute

Approves every draft task of the plan and runs the plan: each approved task becomes a GitHub issue or Jira ticket and is queued as a run, in task order. The plan becomes executing. Rejected tasks are skipped. Answers 400 when no task is left to run, so calling it again after a successful call does not run anything twice.

Authorization

api_key plans
headerAuthorizationBearer <token>

A team API key, made by an admin under Settings, API keys. Send it as Authorization: Bearer chk_....

Scope: plans

Path Parameters

plan_id*string

The plan's id.

Response Body

The plan is running.

application/json
  1. response

A plan that started running.

status*string

Always executing.

Example"executing"
tasks_queued*integer

How many tasks were queued.

Range0 <= value
Example3
curl -X POST 'https://api.coderhelm.com/api/plans/01JB8V0K3M5P7R9T1W3Y5A7C9E/approve-and-execute' \  -H "Authorization: Bearer $CODERHELM_API_KEY"
{  "status": "executing",  "tasks_queued": 3}
Edit on GitHub

Get a plan GET

Returns one plan with its tasks in order. Once the plan runs, each task shows the ticket it became and the run working on it (`run_id`), which you can follow with `GET /api/runs/{run_id}`.

List repositories GET

Lists the repositories connected to the team through the CoderHelm GitHub App, whether CoderHelm works on each, and where its tickets come from. Not paged: a team's repositories come back in one answer.