OpenAPI & machines
Live OpenAPI 3.1 specification, authentication schemes, tags, and how to generate clients.
LogoRouter publishes a generated OpenAPI 3.1 document from the Worker. It is the source of truth for paths, parameters, schemas, and problem responses (application/problem+json).
Canonical URLs
| Resource | Location |
|---|---|
| OpenAPI JSON (recommended) | https://api.logorouter.com/api/openapi.json |
| Alternate when exposed | https://api.logorouter.com/openapi.json |
Prefer the /api/openapi.json path in CI and codegen — it stays aligned with the deployed Worker.
Generate TypeScript definitions (example):
pnpm dlx openapi-typescript https://api.logorouter.com/api/openapi.json -o src/logorouter-api.d.tsAuthentication (in spec)
Operations accept keys in three shapes (mirrored across logo + JSON routes where applicable):
x-api-keyheader — convenient for proxies and cron.Authorization: Bearer <key>— standard server-to-server shape.tokenquery parameter — required for publishable keys embedded in<img src>URLs on the CDN.
Anonymous traffic is permitted only where an operation declares optional security — today that is principally demo-sized logo/CDN GET requests (≤128 px CDN demo tier unless your plan says otherwise).
Tags (logical groups)
| Tag | Covers |
|---|---|
| Status & Plans | GET /health, billing plan catalog helpers. |
| Logos | GET /api/{domain}, GET https://img.logorouter.com/{domain}, Clearbit-compat route, cache refresh/delete. |
| Discovery | GET /api/search, ticker / crypto / name / ISIN logo resolution. |
| Brand Data | Colors, AI intelligence, domain describe, compact meta, unified brand kit. |
| Batch | Paid batch logo + describe workflows. |
Human guides
Markdown pages in this sidebar expand on behaviours that are easier to explain in prose (fallback semantics, retina, Stripe billing UX). Whenever a field stabilises here, openapi.json still wins for machine contracts.
Next: Logo endpoint · Brand colors · Discovery.