Create runs

Runs a repository's workflows at a ref, on demand.

POST /v1/git/runs

Git → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/git/runs`
Method	`POST`
Operation	`post_git_runs`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Runs a repository's workflows at a ref, on demand.

It takes the SAME path a push takes: the request is recorded in the journal and delivered from there, so an explicit run and a pushed one are one mechanism with one idempotency rule and not two that can disagree. Asking twice for the same commit yields the same run.

Request

2 fields, body application/json (required).

Field	In	Type	Required	Description
`ref`	body	string	—	Ref is the branch to run; empty means the repository's default.
`repo`	body	string	—	Repo is the repository to run.

Response

Status	Body	Meaning
`201`	git.workflowRuns	created
`default`	problem-details	refused

201 body — 12 fields.

Field	In	Type	Always	Description
`data`	body	git.workflowRun[]	—	Data is the runs in scope, newest first.
`data[].actor`	body	string	—	Actor is who caused it.
`data[].commit`	body	string	—	Commit is the commit being run, in full.
`data[].createdAt`	body	integer (int64)	—	CreatedAt is when the run was opened, in unix seconds.
`data[].event`	body	string	—	Event is what caused the run, e.g. "push".
`data[].id`	body	string	—	ID addresses this run.
`data[].number`	body	integer (int64)	—	Number is the run's position in its repository, counting from 1 — the handle a person uses ("#4").
`data[].ref`	body	string	—	Ref is the full ref, e.g. "refs/heads/main".
`data[].repo`	body	string	—	Repo is the repository the run is for.
`data[].status`	body	string	—	Status is waiting, running, success, failure, cancelled or skipped.
`data[].updatedAt`	body	integer (int64)	—	UpdatedAt is when its status last changed, in unix seconds.
`data[].workflow`	body	string	—	Workflow is the path of the document being run, e.g. ".hanzo/workflows/ci.yml".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo git runs create

.ts

.py

.go

.rs

.java

import { Configuration, GitApi } from 'hanzoai';

const api = new GitApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postGitRuns({ ref: "<ref>", repo: "<repo>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import GitApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = GitApi(client).post_git_runs(ref="<ref>", repo="<repo>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.GitAPI.PostGitRuns(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, git_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = git_api::post_git_runs(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.GitApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new GitApi(client).postGitRuns();

curl -X POST https://api.hanzo.ai/v1/git/runs \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "ref": "<ref>",
       "repo": "<repo>"
     }'

MCP reaches git through the git tool, which names its 38 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_git_keys"
         }
       }
     }'

Git API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate repos NextCreate webhook