API Reference

Exclusive Cyrillic for digital design

Generate Test Key View SDK Docs

Authentication

Secure all TypeLab endpoints using API keys issued through your developer dashboard. Each key is scoped to specific font families and rendering contexts.

Header Format

Authorization Bearer

Include your secret key in the request header: `Authorization: Bearer tl_live_8x92k4m1p0q7r5s3`. Keys are 32-character alphanumeric strings generated via the TypeLab console under Settings > API Access.

Scopes

Permission Levels

Keys support three scopes: `read:glyphs` for metadata retrieval, `render:otf` for variable font generation, and `admin:billing` for subscription management. Default keys are restricted to `read:glyphs` until elevated.

Methods

Interact with the TypeLab font repository using standard REST verbs. All requests must be made over HTTPS to `api.typelab.design/v2`.

GET

Retrieve Font Metadata

`/fonts/{family_id}` returns JSON containing axis ranges, weight steps, and Cyrillic coverage percentages. Example response includes `glyph_count: 214` and `cyrillic_support: full`.

POST

Generate Subset

`/render/subset` accepts a payload with `text`, `family`, and `weight` parameters. Returns a compressed `.woff2` blob optimized for Cyrillic UI components. Default compression ratio: 0.68.

PATCH

Update License Tier

`/subscriptions/{tier_id}` modifies rendering quotas and access to premium foundry collections. Requires `admin:billing` scope and returns a 200 OK with updated `monthly_render_limit`.

Errors

The API uses conventional HTTP status codes to indicate success or failure. All error responses return a structured JSON object with a machine-readable code.

401

Invalid Credentials

Returned when the `Authorization` header is missing, malformed, or expired. Response body: `{"error": "auth_failed", "message": "Token tl_test... does not match active registry."}`

404

Resource Unavailable

Triggered when requesting a deprecated font family or unsupported Cyrillic subset. Response body: `{"error": "not_found", "message": "Family 'MoscowSans' has been archived since v1.4."}`

503

Rendering Engine Busy

Indicates temporary overload on the OpenType compilation queue. Response body: `{"error": "service_unavailable", "message": "Glyph rasterization queue is at 94% capacity. Retry in 30s."}`

Rate Limits

Request throttling ensures consistent latency across all TypeLab foundry endpoints. Limits are enforced per API key and reset on a rolling 60-second window.

Free Tier

120 Requests / Minute

Covers metadata lookups and lightweight subset generation. Exceeding this threshold returns `429 Too Many Requests` with a `Retry-After: 15` header.

Professional Tier

2,500 Requests / Minute

Designed for production CI/CD pipelines and dynamic type rendering. Includes priority queue access for `.otf` compilation and bulk Cyrillic validation jobs.

Enterprise

Dedicated Allocation

Custom throughput negotiated via SLA. Includes isolated rendering nodes, guaranteed 12ms p95 latency, and webhook alerts for quota utilization above 80%.