getfavi

favi API errors

favi returns RFC 9457 application/problem+json on API failures. Each document includes type (URI), title, status, detail, instance, a machine-readable code, and a hint for recovery. HTML error pages are not used under /api.

Error codes

not_found, method_not_allowed, invalid_json, invalid_shape, invalid_bg_mode, invalid_text, missing_export_source, icon_not_found, index_unavailable, export_failed, rate_limited. Fragment identifiers on this page match those codes (for example /docs/errors#icon_not_found).

Example

{
  "type": "https://getfavi.vercel.app/docs/errors#icon_not_found",
  "title": "Icon not found",
  "status": 404,
  "detail": "No icon matches that library, name, and style.",
  "instance": "/api/icons/lucide/missing",
  "code": "icon_not_found",
  "hint": "GET /api/libraries for slugs, then GET /api/icons?q= to find a name."
}