Brand Peel Developer Resources & API - Documentation

Brand Peel provides machine-readable APIs, an official CLI tool, and open schemas designed for software developers and AI agents.

Public REST API Endpoints

All public API endpoints are served from https://brandpeel.app with CORS enabled and RFC 8594 rate limiting and versioning headers.

Endpoint	Method	Purpose	Documentation
`/api/v1/health`	`GET`	Health check & agent discovery URLs	Health Details
`/api/v1/release/latest`	`GET`	Current desktop app downloads & checksums	Releases
`/api/v1/tools`	`GET`	190+ free branding & color utilities	Tools API
`/api/v1/tools/{slug}`	`GET`	Single tool calculation schema	Tool Slug API
`/api/v1/brand-guide/schema`	`GET`	JSON Schema for design token exports	Token Schema
`/api/v1/agent-info`	`GET`	Agent guidance & function calling	Agent Info
`/api/v1/cli/manifest`	`GET`	Official CLI tool execution manifest	CLI Manifest

OpenAPI 3.1 Specification

The official OpenAPI 3.1 schema is published at:

JSON: https://brandpeel.app/openapi.json
YAML: https://brandpeel.app/openapi.yaml

Model Context Protocol (MCP) Server

Connect Brand Peel directly to your AI IDEs (Claude Desktop, Cursor, Windsurf, Antigravity):

{
  "mcpServers": {
    "brandpeel": {
      "command": "npx",
      "args": ["-y", "@unpeeled/mcp-server"]
    }
  }
}

Official CLI Tool

Run brand transformations and token compilers in CI/CD without installation:

# Export brand tokens to Tailwind CSS v4 variables
npx brandpeel export --format tailwind-v4 --output ./src/theme.css

# Validate brand package schema and WCAG contrast
npx brandpeel doctor --strict

# Compile Markdown brand guidelines into repo documentation
npx brandpeel compile-book --input ./brand.json --output ./BRAND.md

API Versioning & Deprecation Policy

Semantic Versioning: All production endpoints are scoped under /api/v1/. Breaking changes will only occur under /api/v2/.
90-Day Sunset Window: Deprecated endpoints remain fully operational for at least 90 days with Sunset and Deprecation response headers.
Deprecation Policy Link: All endpoints emit Link: <https://brandpeel.app/developers#api-versioning>; rel="deprecation".