Developer Overview
The programmatic surface of lnkify provides several interfaces for building integrations:
| Interface | Endpoint | Purpose |
|---|---|---|
| GraphQL API | POST /graphql | Full CRUD, auth, analytics — single endpoint |
| HTTP Routes | / (various) | Slug redirects, QR codes, bio pages, AI discovery |
| MCP Server | Streamable HTTP | AI agent tools for shortlink management |
| CLI | lnkify (npm) | Manage links from the terminal; wraps the GraphQL API |
GraphQL API
The primary API. All queries and mutations go through a single endpoint. Authenticate with a JWT or API key. Full schema introspection available in development.
- Base URL:
https://lnkify.io/graphql - Content-Type:
application/json - Auth header:
Authorization: Bearer <token>orx-api-key: lf_live_<key> - Sections: Overview · Queries · Mutations · Types · Examples
HTTP Routes
Lightweight endpoints that don't require GraphQL:
GET /<slug>— 302 redirect to the target URL, with optional click trackingGET /<slug>/qr.svg— QR code for a shortlink (svgorpng)GET /bio/<slug>— public link-in-bio pageGET /llms.txt— AI agent discovery file listing MCP tools and endpointsGET /llms-full.txt— Expanded reference with full tool schemas
MCP Server
Streamable HTTP Model Context Protocol server for AI agents:
- Base URL:
https://mcp.lnkify.io/ - Supports the same tools as the GraphQL API via JSON-RPC
- Auth: same headers as GraphQL, same identity resolution
CLI
A branded command-line tool that wraps the GraphQL API:
- Install:
npm install -g lnkify - Manage links, domains, API keys, and analytics from the terminal
- Local-first, with profiles for remote servers and a
--jsonmode for scripting - Can also run as a local MCP server (
lnkify mcp serve) - Sections: Overview · Installation · Authentication · Commands · Examples
Quick Links
- Authentication — JWT and API key auth
- Rate Limits — Per-identity rate limiting
- Errors — Error formats and handling
- HTTP Routes — Redirect and discovery endpoints
- CLI — Manage lnkify from the terminal