v1.0FREENO AUTH

Documentation

Everything you need to integrate 18,000+ icons into your project.

Quick Start

1

Get an icon

Fetch any icon by its name

URL
https://hylab.vercel.app/api/icons/home
2

Customize it

Add color, size, and format parameters

URL
https://hylab.vercel.app/api/icons/home?color=7c9a82&size=32&format=svg
3

Use it

Drop it into your HTML, React, or any framework

URL
<img src="https://hylab.vercel.app/api/icons/home?color=7c9a82" alt="Home" />
GET/api/icons

List all icons with pagination and optional category filter

Query Parameters

NameTypeDefaultDescription
pagenumber1Page number
limitnumber50Items per page (max 100)
categorystringFilter by category slug
EXAMPLE
https://hylab.vercel.app/api/icons?page=1&limit=20&category=navigation
GET/api/icons/:name

Get a single icon by name with optional customization

Parameters

NameTypeRequiredDescription
namepathYesIcon name (e.g., home, search, heart)

Query Parameters

NameTypeDefaultDescription
colorstringcurrentColorHex color without # (e.g., 7c9a82)
sizenumber24Size in pixels (1-512)
strokenumber2Stroke width (0.5-4)
formatstringsvgOutput format: svg, png, or webp
EXAMPLE
https://hylab.vercel.app/api/icons/home?color=7c9a82&size=32&format=svg
GET/api/icons/search

Search icons by name, tags, or category

Parameters

NameTypeRequiredDescription
qqueryYesSearch query string
EXAMPLE
https://hylab.vercel.app/api/icons/search?q=arrow
GET/api/icons/categories

List all categories with icon counts

EXAMPLE
https://hylab.vercel.app/api/icons/categories
GET/api/icons/sets

List all icon sets (sources) with counts

EXAMPLE
https://hylab.vercel.app/api/icons/sets

AI Agent Prompt

Copy this prompt to any AI coding assistant

Use this prompt to teach any AI agent (Cursor, Copilot, Windsurf, Claude, etc.) how to fetch and use icons from HyLab API in your project.

SYSTEM PROMPT
You are an AI coding assistant that helps developers integrate icons into their projects using the HyLab Icons API.

## HyLab API Reference

Base URL: https://hylab.vercel.app

### Endpoints

1. **Get Icon by Name**
   GET /api/icons/:name
   - color (query): Hex color without # (e.g., 7c9a82)
   - size (query): Size in pixels 1-512 (default: 24)
   - stroke (query): Stroke width 0.5-4 (default: 2)
   - format (query): svg, png, or webp (default: svg)
   - fill (query): true/false - fill icon instead of stroke

2. **Search Icons**
   GET /api/icons/search?q=keyword
   Returns icons matching name, tags, or category.

3. **List Categories**
   GET /api/icons/categories

4. **List Icon Sets**
   GET /api/icons/sets

5. **List All Icons (Paginated)**
   GET /api/icons?page=1&limit=50&category=navigation

### How to Use

When a developer asks for an icon:
1. Search for the icon using /api/icons/search?q={keyword}
2. Return the full URL: https://hylab.vercel.app/api/icons/{name}?color={color}&size={size}
3. For HTML: <img src="URL" alt="name" />
4. For React/Next.js: Use fetch() or <img> tag with the URL
5. For CSS background: url('URL')

### Example Responses

Developer: "I need a home icon"
Response: https://hylab.vercel.app/api/icons/home?color=7c9a82&size=24

Developer: "Add a search icon to my navbar"
Response: Use this in your component:
<img src="https://hylab.vercel.app/api/icons/search?color=ffffff&size=20" alt="Search" />

Developer: "I need a red heart icon in PNG format"
Response: https://hylab.vercel.app/api/icons/heart?color=ef4444&size=48&format=png

### Available Categories
navigation, action, communication, social, files, media, interface, status, commerce, charts, layout, development, weather, miscellaneous

Always provide the complete, working URL. Never use placeholder domains.

Pro Tip

Add this prompt to your project's .cursorrules, AGENTS.md, or .github/copilot-instructions.md file so the AI always knows how to use HyLab.

Rate Limits & Caching

All API responses include Cache-Control: public, max-age=3600 headers.

CORS is enabled for all origins. No API key or authentication required.

PNG and WebP conversions use Sharp for high-performance image processing on the server.