Create badge

POST /v1/reward/me/github/badge

Reward → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/reward/me/github/badge`
Method	`POST`
Operation	`post_reward_me_github_badge`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Verifies against GitHub's API that a project of yours carries a Hanzo badge image in its README, and puts one claim to staff for each kind it carries: your live profile badge, your rank badge, or the Built with Hanzo badge. The project must be public, not a fork, and owned by the GitHub account you linked at sign-in. Each kind is counted once for the project, so asking again claims nothing twice. Asked at most ten times an hour.

Request

1 field, body application/json (required).

Field	In	Type	Required	Description
`repo`	body	string	—	Repo is the project as owner/name on GitHub.

Response

Status	Body	Meaning
`200`	reward.badgeOut	ok
`default`	problem-details	refused

200 body — 3 fields.

Field	In	Type	Always	Description
`badges`	body	string[]	—	Badges are the kinds the README carries: profile (the live badge of a rewards profile), rank (the live rank badge) and built (the static Built with Hanzo badge).
`claimed`	body	integer (int64)	—	Claimed is how many claims this check made for staff: 0 when every badge of the project had been claimed already.
`repo`	body	string	—	Repo is the project, as GitHub names it.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo reward me github badge

.ts

.py

.go

.rs

.java

import { Configuration, RewardApi } from 'hanzoai';

const api = new RewardApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postRewardMeGithubBadge({ repo: "<repo>" });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = RewardApi(client).post_reward_me_github_badge(repo="<repo>")

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

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

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

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

let result = reward_api::post_reward_me_github_badge(&cfg, Default::default()).await?;

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

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

var result = new RewardApi(client).postRewardMeGithubBadge();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were 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 -X POST https://api.hanzo.ai/v1/reward/me/github/badge \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "repo": "<repo>"
     }'

MCP reaches reward through the reward tool, which names its 7 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_reward_me_posts"
         }
       }
     }'

Reward API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousCreate events NextCreate check