API Documentation

Access 168 research-backed UX/UI principles programmatically. Build tools, integrations, and workflows.

Base URLhttps://uxuiprinciples.com/api/v1

Authentication

All requests require an API key. Include it in the request headers.

Authorization Header (recommended)

curl -X GET "https://uxuiprinciples.com/api/v1/principles" \
  -H "Authorization: Bearer uxui_live_your_key_here"

X-API-Key Header

curl -X GET "https://uxuiprinciples.com/api/v1/principles" \
  -H "X-API-Key: uxui_live_your_key_here"

Requests without an API key receive free tier access (limited to 12 principles).

Get API Key

Rate Limits

Rate limits are applied per IP address, resetting every hour.

TierLimit

Free100 requests/hour

ProPro1,000 requests/hour

When rate limited, responses include Retry-After header.

Endpoints

GET/principles

Retrieve UX/UI principles with optional filtering.

Query Parameters

localeLanguage code (en, es)

slugGet specific principle by slug

partFilter by part (e.g., part-1)

difficultyFilter by difficulty (beginner, intermediate, advanced)

searchSearch in title, slug, and tags

include_contentInclude full MDX content (Pro only)

Example

curl "https://uxuiprinciples.com/api/v1/principles?locale=en&part=part-1"

GET/smellsPro

Retrieve UX anti-patterns and their fixes.

Query Parameters

localeLanguage code (en, es)

categoryFilter by category

searchSearch in titles and descriptions

Example

curl "https://uxuiprinciples.com/api/v1/smells?locale=en" \
  -H "Authorization: Bearer uxui_live_your_key_here"

GET/flowsPro

Retrieve user flow checklists with pre-flight and post-flight items.

Query Parameters

localeLanguage code (en, es)

slugGet specific flow by slug

Example

curl "https://uxuiprinciples.com/api/v1/flows?locale=en" \
  -H "Authorization: Bearer uxui_live_your_key_here"

Response Format

All responses follow a consistent JSON structure.

Success Response

{
  "success": true,
  "data": [
    {
      "slug": "chunking",
      "title": "Chunking",
      "code": "F.1.1.01",
      "part": "part-1",
      "partName": "Foundations",
      "difficulty": "beginner",
      "readTime": 4,
      "aiSummary": "Miller's Law demonstrates...",
      "tags": ["cognitive-load", "memory"]
    }
  ],
  "meta": {
    "timestamp": "2026-01-17T12:00:00.000Z",
    "version": "v1",
    "tier": "pro",
    "count": 168,
    "total": 168
  }
}

Error Response

{
  "success": false,
  "error": {
    "message": "Invalid API key",
    "code": "AUTH_FAILED",
    "status": 401
  },
  "meta": {
    "timestamp": "2026-01-17T12:00:00.000Z",
    "version": "v1"
  }
}

Error Codes

Standard error codes returned by the API.

400Bad Request - Invalid parameters

401Unauthorized - Invalid or missing API key

403Forbidden - Pro tier required

404Not Found - Resource does not exist

429Rate Limited - Too many requests

500Server Error - Try again later

Also Available

MCP Server

Prefer working with Claude directly? Use our MCP Server to access UX principles in Claude Code and Claude Desktop conversations.

View MCP Documentation

Ready to integrate?

Get your API key and start building with 168 research-backed principles.

Get API Access

$19/year • Or get the Developer Bundle with MCP Server for $29/year

{ "success": true, "data": [ { "slug": "chunking", "title": "Chunking", "code": "F.1.1.01", "part": "part-1", "partName": "Foundations", "difficulty": "beginner", "readTime": 4, "aiSummary": "Miller's Law demonstrates...", "tags": ["cognitive-load", "memory"] } ], "meta": { "timestamp": "2026-01-17T12:00:00.000Z", "version": "v1", "tier": "pro", "count": 168, "total": 168 } }

{ "success": false, "error": { "message": "Invalid API key", "code": "AUTH_FAILED", "status": 401 }, "meta": { "timestamp": "2026-01-17T12:00:00.000Z", "version": "v1" } }