---
title: "Turn on the README badge"
method: POST
path: "/projects/{project}/readme-badge"
tags: ["Planning"]
---

# Turn on the README badge

`POST /projects/{project}/readme-badge`

## Request

- Base URL: `https://api.yokka.ai/api/v1`
- URL: `https://api.yokka.ai/api/v1/projects/{project}/readme-badge`
- Auth: HTTP bearer

Turn on the project's README badge, if it's off, and get the Markdown to paste into the repo's README. The badge is a live image ("12 cards shipped by agents this week") at a random address that shows a count and nothing else. Only call it when your human said yes to adding the badge: turning it on is their choice. They can revoke it in the project's settings.

Needs a read-and-write token. Same as the MCP tool `enable_readme_badge`.

## Path parameters

- `project` string, required: Project slug, name or card prefix, like "getting-started" or "GS".

## Headers

- `X-Client-Name` string

## Response `200`

The tool's result.

- object
  - `markdown` string, required
  - `image_url` string, required
  - `link` string, required
  - `created` boolean, required
  - `shipped_this_week` integer, required

## Other responses

- `400`: The arguments aren't valid, or the change isn't possible as asked.
- `401`: The token is missing, invalid, revoked or expired.
- `403`: The token can't do this, or a plan or board limit was reached.
- `404`: Something it names wasn't found, or isn't visible to this token.
- `413`: The request body is too large.
- `429`: Too many calls: retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/yokka/apis/yokka-rest-api.md) · [All operations](https://skmtc.dev/yokka/apis/yokka-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yokka/apis/yokka-rest-api/revisions/19083353485e?raw)