Documentation
Everything you need to create beautiful link previews, track clicks, and integrate Peeksy into your workflow.
Quick start
Create an account
Sign up free at peeksy.space — no credit card required.
Create your first link
Paste any URL into the dashboard. Peeksy fetches metadata and generates a branded short link instantly.
Customize the preview
Choose a template or let AI generate your OG image. Edit the title and description, or click "AI Copy" to auto-generate.
Share & track
Copy your short link and share it anywhere. View clicks, referrers, and geography in real-time analytics.
Guides & features
OG Image Generation
Learn how to create AI-powered Open Graph images — templates, custom branding, and the AI copy engine.
Custom Domains
Set up your own domain (links.yourbrand.com) with a single CNAME record. Automatic SSL included.
SEO Audits
Run on-demand SEO audits on any destination page. Get letter grades (A–F) and actionable fix suggestions.
Analytics
Clicks, referrers, geo breakdowns, devices, and time-series charts. Free plan gets 7 days; Pro gets 90.
Link Management
Create, update, and organize short links. Edit destinations, slugs, and OG metadata without changing the URL.
Integrations
Works with Notion, Webflow, Framer, YouTube, and more. See platform-specific features and setup guides.
API & SDK reference
Build on top of Peeksy with our TypeScript SDK, REST API, or MCP Server for AI agents.
@peeksy/sdk
TypeScriptOfficial TypeScript/JavaScript SDK. Create links, generate OG images, run SEO audits, and pull analytics from your own codebase.
Requires Pro+ plan
Full referenceimport { Peeksy } from "@peeksy/sdk"
const peeksy = new Peeksy({ apiKey: "pk_..." })
const link = await peeksy.links.create({
url: "https://example.com",
template: "modern-dark",
})
console.log(link.shortUrl)REST API
HTTPFull REST API with JWT authentication. Create links, generate images, run audits, and query analytics over HTTP.
Requires Pro+ plan
Full referencecurl -X POST https://api.peeksy.space/links \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com","title":"My Link"}'MCP Server
AI AgentsConnect Claude, Cursor, or any MCP-compatible AI agent to your Peeksy account. Manage links and analytics without leaving the chat.
Requires Business plan
Full reference{
"mcpServers": {
"peeksy": {
"url": "https://api.peeksy.space/mcp",
"headers": {
"Authorization": "Bearer YOUR_TOKEN"
}
}
}
}