OpenAPI specification

Download

• openapi.yaml — YAML (recommended)

Replace the server URL with your deployment origin when importing (the spec uses / as a relative base).

Interactive explorer

Try endpoints below. For v1, use the Authorize button with Bearer lt_….

Loading API explorer…

What is covered

• Pro API v1 — list, create, get, update, delete links; bulk create; click analytics (GET /api/v1/links/{id}/clicks)
• Session API — same link operations with Clerk cookie auth; batch create and daily quota
• Guest API — public quick shorten, bulk, and quota
• Workspace — API keys and custom domains (Pro)
• Wizard helpers — AI meta generation and image upload

Authentication in tools

For v1, set header Authorization: Bearer lt_… from your Dashboard. Session endpoints require a Clerk session cookie — use the browser or same-origin fetch with credentials.

Human-readable reference

REST API overview · API v1 reference · Clicks & campaign links