---
title: "Get Readme Badge"
method: GET
path: "/api/v1/badges/readme/{entity_id}"
tags: ["trust-badges"]
---

# Get Readme Badge

`GET /api/v1/badges/readme/{entity_id}`

## Request

- Base URL: `https://agentavow.com` (the document declares no server; this is the origin it was published from)
- URL: `https://agentavow.com/api/v1/badges/readme/{entity_id}`
- Auth: none declared

Return a copy-paste snippet for embedding a trust badge in a README.

## Path parameters

- `entity_id` string, uuid, required

## Query parameters

- `format` 'markdown' | 'html' | 'rst': Snippet format: markdown, html, or rst
- `style` 'compact' | 'detailed' | 'minimal' | 'flat-square': Badge visual style

## Response `200`

Badge embed snippet

- unknown

## Other responses

- `404`: Entity not found
- `422`: Validation Error

---

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