Get runs

Returns one run.

GET /v1/git/runs/{id}

Addresshttps://api.hanzo.ai/v1/git/runs/{id}
MethodGET
Operationget_git_runs_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one run.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the run to read, from the :id path segment.

Response

StatusBodyMeaning
200git.workflowRunok
defaultproblem-detailsrefused

200 body — 11 fields.

FieldInTypeAlwaysDescription
actorbodystring—Actor is who caused it.
commitbodystring—Commit is the commit being run, in full.
createdAtbodyinteger (int64)—CreatedAt is when the run was opened, in unix seconds.
eventbodystring—Event is what caused the run, e.g. "push".
idbodystring—ID addresses this run.
numberbodyinteger (int64)—Number is the run's position in its repository, counting from 1 — the handle a person uses ("#4").
refbodystring—Ref is the full ref, e.g. "refs/heads/main".
repobodystring—Repo is the repository the run is for.
statusbodystring—Status is waiting, running, success, failure, cancelled or skipped.
updatedAtbodyinteger (int64)—UpdatedAt is when its status last changed, in unix seconds.
workflowbodystring—Workflow is the path of the document being run, e.g. ".hanzo/workflows/ci.yml".

Failure carries the platform error shape — see Errors.

Examples

hanzo git runs get <id>
import { Configuration, GitApi } from 'hanzoai';

const api = new GitApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getGitRunsById({ id: 'id' });
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).get_git_runs_by_id(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.GitAPI.GetGitRunsById(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::get_git_runs_by_id(&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).getGitRunsById();
curl https://api.hanzo.ai/v1/git/runs/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

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?