---
title: "Package Badge"
method: GET
path: "/api/v1/public/scan/package/{surface}/{name}/badge"
tags: ["public-scan"]
---

# Package Badge

`GET /api/v1/public/scan/package/{surface}/{name}/badge`

## 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/public/scan/package/{surface}/{name}/badge`
- Auth: none declared

README badge for a published package, including names with a slash: scoped
npm (`/package/npm/@scope/name/badge`) and Hugging Face
(`/package/huggingface/org/model/badge`). Same output and query options as
`/{owner}/{repo}/badge`.

## Path parameters

- `surface` string, required
- `name` string, required

## Response `200`

Successful Response

## Other responses

- `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)