🐾推荐 FEATURED·PurrCat

Guide - 4 min

Add an AgentPets badge to a README or launch post

Use the public AgentPets badge endpoint to add install badges to GitHub README files, docs, launch posts, and creator pages with trackable pet links.

1

Choose the pet slug

Every approved pet has a stable slug. Use it in the SVG badge endpoint and link the badge to the pet page.

2

Add Markdown to your README

The badge is an SVG image URL, so it works in GitHub README files and most docs systems.

[![AgentPets](https://agentpets.dev/api/v1/badge/boba)](https://agentpets.dev/pets/boba?ref=badge)
3

Track the sharing loop

The badge sends readers to the public pet page where they can install, like, embed, or find the creator.

Useful API surfaces

Public API, badges, and embeds are versioned under stable URLs so README snippets and integrations can keep working as the product evolves.