OpenapiGit
Returns the README at the tree root as plain text — unrendered, so the caller…
Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it.
GET /v1/git/repos/{name}/readme
| Address | https://api.hanzo.ai/v1/git/repos/{name}/readme |
| Method | GET |
| Operation | get_git_repos_by_name_readme |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it. A repo with no README is not found.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name is the repo to read, from the :name path segment. |
ref | query | string | — | Ref is a branch, tag or commit; empty means the repo's HEAD. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | readmeJSON | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
content | body | string | — | Content is the file's text, verbatim and unrendered. |
encoding | body | string | — | Encoding is always "utf8" — a README is text by definition. |
path | body | string | — | Path is the file the README was found at (README.md, README, …). |
Failure carries the platform error shape — see Errors.
Examples
hanzo git repos readme <name>import { Configuration, GitApi } from 'hanzoai';
const api = new GitApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getGitReposByNameReadme({ name: 'name' });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_repos_by_name_readme(name='name')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.GitAPI.GetGitReposByNameReadme(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_repos_by_name_readme(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.GitApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new GitApi(client).getGitReposByNameReadme();curl https://api.hanzo.ai/v1/git/repos/<name>/readme \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches git through the git tool, which names its 56 operations with its own verbs — this one among them, under a name only the door 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"
}
}
}'How is this guide?