List workflows

Reports the workflows a repository declares at a ref and which declared pool would execute each job — the answer to "would a push here run, and where".

GET /v1/git/workflows

Git → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/git/workflows`
Method	`GET`
Operation	`get_git_workflows`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reports the workflows a repository declares at a ref and which declared pool would execute each job — the answer to "would a push here run, and where".

Request

2 fields.

Field	In	Type	Required	Description
`repo`	query	string	—	Repo is the repository whose workflows to read.
`ref`	query	string	—	Ref is the branch to read them at; empty means the default.

Response

Status	Body	Meaning
`200`	git.workflowList	ok
`default`	problem-details	refused

200 body — 7 fields.

Field	In	Type	Always	Description
`data`	body	git.workflowView[]	—	Data is the workflows the repository declares at the ref.
`data[].fault`	body	string	—	Fault is why this document cannot run at all, when it cannot be read.
`data[].jobs`	body	git.jobView[]	—	Jobs is what it declares, and where each would run.
`data[].jobs[].name`	body	string	—	Name is the job's id in the workflow document.
`data[].jobs[].pool`	body	string	—	Pool is the declared pool carrying every one of those labels, or empty when no pool does — which is the answer to "why is nothing running".
`data[].jobs[].runsOn`	body	string[]	—	RunsOn is the labels the job asked for.
`data[].name`	body	string	—	Name is the document's path in the repository.

Failure carries the platform error shape — see Errors.

Examples

hanzo git workflows

import { Configuration, GitApi } from 'hanzoai';

const api = new GitApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getGitWorkflows();

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_workflows()

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

resp, _, err := client.GitAPI.GetGitWorkflows(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_workflows(&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).getGitWorkflows();

The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/git/workflows \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches git through the git tool, which names its 56 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": "get_git"
         }
       }
     }'

Git API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page