Getting Started
Welcome to the ColoursUI developer documentation. This guide will help you integrate our platform into your applications.
Authentication
API keys, OAuth 2.0, and JWT token management
📦SDKs
Client libraries for Python, Node.js, Go, and Rust
📡API Reference
REST endpoints, parameters, and response schemas
📖Guides
Step-by-step tutorials for common integrations
📋Changelog
Latest releases and breaking changes
Quick Start
Get up and running with ColoursUI in minutes. Choose your preferred SDK and follow the installation instructions below.
Python
pip install coloursuiNode.js
npm install @coloursui/sdkGo
go get github.com/coloursui/sdk-goRust
cargo add coloursuiCore Concepts
- Palettes — Generated colour scales with perceptual uniformity via the Palette Generator
- Tokens — Semantic design tokens exported for any framework using Design Tokens
- Contrast — WCAG-compliant contrast checking with the Contrast Checker
- Themes — Light/dark and multi-brand themes via Theme Builder
- Plugins — Framework integrations including the Tailwind Plugin
Authentication
All API requests require an API key. You can generate keys from the admin dashboard under Settings → API Keys.
Rate Limits
Default rate limits apply per API key. Pro plans have configurable limits. Contact us for custom arrangements.
Frequently Asked Questions
ColoursUI provides official SDKs for Python, Node.js, Go, and Rust. Community-maintained SDKs are available for Java, PHP, and Ruby.
All SDKs include built-in retry logic with exponential backoff. Default rate limits are 1000 requests/minute for standard plans and 10,000 for Team plans.
Yes! The free tier includes 10,000 API calls per month, 1 GB of colour data storage, and access to the standard palette endpoints.
See our migration guide under Guides → Version Migration. The main changes are the new authentication flow and updated response schemas for palette endpoints.
Team plan customers can deploy ColoursUI on-premise or in their own cloud environment. Contact sales for self-hosted licensing options.