OpenAPI specification

Download or import the Linktrap OpenAPI 3.1 spec into Postman, Insomnia, or AI agent tooling.

Download

openapi.yaml — YAML (recommended)

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

What is covered

Pro API v1 — list, create, get, update, delete links; click analytics (GET /api/v1/links/{id}/clicks)
Session API — same link operations with Clerk cookie auth
Guest API — public quick shorten + optional cloaking
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