Brand Peel Developer Portal & API Documentation
Quickstart integration
Access Brand Peel endpoints using cURL, TypeScript, or Python. All endpoints support standard CORS and content negotiation.
curl -s https://brandpeel.app/api/v1/tools?category=Design%20System \
-H "Accept: application/json"
Request standard JSON or send Accept: text/markdown for Markdown representation.
import { fetch } from 'undici'
// Fetch public tools catalog
const response = await fetch('https://brandpeel.app/api/v1/tools')
const data = await response.json()
console.log('Available Brand Peel tools:', data.total)
Full TypeScript definitions available through the OpenAPI 3.1 specification.
import requests
# Fetch OpenAPI spec or brand guide schema
schema = requests.get("https://brandpeel.app/api/v1/brand-guide/schema").json()
print("Brand Package Title:", schema["title"])
Easily load JSON schemas and integrate token exports into automated CI/CD pipelines.
Public REST API reference
Reachable, unauthenticated endpoints for software applications, AI agents, and development scripts.
Check API and agent service health
Returns operational status, version, and links to machine-readable agent discovery documents.
Retrieve latest desktop release downloads
Get download URLs and checksums for Windows (setup/portable x64), macOS (universal DMG), and Linux.
List and search 100+ free branding utilities
Filter by category (Design System, Positioning, etc.) or search keywords.
Get single tool specification
Detailed field options, outcomes, and calculation parameters.
JSON Schema for brand packages & tokens
Standardized JSON Schema draft 2020-12 for color palettes, typography, and theme exports.
Agent capabilities & function calling specs
Machine-readable decision criteria and LLM function calling definitions.
CLI commands & execution manifest
Command definitions for scripting brand token transformations.
Brand Peel CLI tool
Script brand token validations, conversions, and theme generation from your terminal.
Package: brandpeel
Execute without permanent installation via npx or install globally.
# Export brand tokens to Tailwind CSS v4 variables
npx brandpeel export --format tailwind-v4 --output ./src/theme.css
# Validate brand package schema and check WCAG contrast compliance
npx brandpeel doctor --strict
# Compile Markdown brand guidelines into repo documentation
npx brandpeel compile-book --input ./brand.json --output ./BRAND.md
Model Context Protocol (MCP) server
Connect Brand Peel tools directly to Claude Desktop, Cursor, Windsurf, and Antigravity IDEs.
Add the following configuration to your mcp_config.json or Claude configuration file:
{
"mcpServers": {
"brandpeel": {
"command": "npx",
"args": ["-y", "@unpeeled/mcp-server"]
}
}
}
This gives your AI assistant tools to inspect local brand books, generate palettes, and export design tokens during coding sessions.
API versioning & deprecation policy
Our stability commitment and deprecation lifecycle for developers, agents, and automation scripts.
URL versioning
All production endpoints are namespaced under /api/v1/. Breaking schema changes will always be introduced under a new version prefix (/api/v2/).
90-day sunset window
Deprecated endpoints remain functional for a minimum of 90 calendar days following official deprecation announcements before retirement.
RFC response headers
Every API response includes X-API-Version: 1.0.0 and standard RFC 8594 Sunset / Deprecation headers.

