Powerful, flexible, and developer-friendly REST API for integrating our design system components.
Jump to Endpoints
All requests should be made to api.essentiaiav.com.
Authenticated by adding your API key to the Authorization header.
Authorization: Bearer <your_api_key>
You can find your API key in your account settings.
All endpoints use version 2 of our API. You can specify the version in the path:
/2/components/buttons
Retrieve metadata about all available components and their properties. Returns a JSON array of component info.
{
"status": "success",
"components": [
{
"name": "Button",
"props": {
"variant": ["primary", "secondary", "ghost"],
"size": ["sm", "md", "lg"]
}
}
]
}
Get renderable HTML examples for a component. Replace <id> with component name.
{
"status": "success",
"name": "Button",
"example": "<button class="px-4 py-2 bg-indigo-600 text-white rounded">Click Me</button>"
}
Here's how you can fetch component data using your API key:
curl 'https://api.essentiaiav.com/2/components' \ -H 'Authorization: Bearer YOUR_API_KEY'
The response will include metadata and usage examples for all components.
{
"status": "success",
"components": [
{
"id": "button",
"props": {
"variant": ["primary", "secondary"],
"size": ["small", "medium", "large"]
},
"defaultExample": "<button>Default</button>"
}
]
}