# favi API catalog

The favi API is a public, keyless HTTP API hosted at https://getfavi.vercel.app. Use it to search free icon libraries and export favicon packages.

## Machine-readable resources

- [OpenAPI 3.1 specification](https://getfavi.vercel.app/openapi.json)
- [API index](https://getfavi.vercel.app/api/v1)
- [Developer resources](https://getfavi.vercel.app/docs)
- [Agent index](https://getfavi.vercel.app/llms.txt)
- [Agent skill](https://getfavi.vercel.app/skills/favi/SKILL.md)

## Endpoints

- GET https://getfavi.vercel.app/api/v1/health — service status and indexed icon count
- GET https://getfavi.vercel.app/api/v1/libraries — supported icon packs, licenses, and styles
- GET https://getfavi.vercel.app/api/v1/icons — search the icon catalog
- GET https://getfavi.vercel.app/api/v1/icons/{library}/{name} — fetch an exact icon
- POST https://getfavi.vercel.app/api/v1/export — export a favicon zip

Authentication is not required. Prefer the canonical `/api/v1/` paths; unversioned `/api/` paths are stable aliases. Production responses are rate-limited by client IP and return standard RateLimit headers. Errors use RFC 9457 `application/problem+json`.