Documentation

Everything you need to create beautiful link previews, track clicks, and integrate Peeksy into your workflow.

Quick start

Create an account

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.

Learn more

Custom Domains

Set up your own domain (links.yourbrand.com) with a single CNAME record. Automatic SSL included.

Learn more

SEO Audits

Run on-demand SEO audits on any destination page. Get letter grades (A–F) and actionable fix suggestions.

Learn more

Analytics

Clicks, referrers, geo breakdowns, devices, and time-series charts. Free plan gets 7 days; Pro gets 90.

Learn more

Link Management

Create, update, and organize short links. Edit destinations, slugs, and OG metadata without changing the URL.

Learn more

Integrations

Works with Notion, Webflow, Framer, YouTube, and more. See platform-specific features and setup guides.

Learn more

API & SDK reference

Build on top of Peeksy with our TypeScript SDK, REST API, or MCP Server for AI agents.

@peeksy/sdk

TypeScript

Official TypeScript/JavaScript SDK. Create links, generate OG images, run SEO audits, and pull analytics from your own codebase.

$npm install @peeksy/sdk

Requires Pro+ plan

Full reference

import { 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

HTTP

Full REST API with JWT authentication. Create links, generate images, run audits, and query analytics over HTTP.

Requires Pro+ plan

Full reference

curl -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 Agents

Connect 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"
      }
    }
  }
}

AI-native

MCP server for AI agents

Peeksy ships a hosted Model Context Protocol server, so Claude Code, Cursor, Windsurf, or any MCP-compatible agent can create links, generate previews, run SEO audits, and pull analytics on your behalf.

Endpoint

https://api.peeksy.space/mcp

Protocol

MCP 2024-11-05 · JSON-RPC 2.0 over HTTP

Auth

Bearer JWT (your API token) · Business plan

Manifest

GET https://api.peeksy.space/mcp — no auth required

Available tools

list_links

List the authenticated user's short links.

create_link

Create a new branded short link.

update_link

Update a link's destination, slug, or OG metadata.

delete_link

Delete a short link.

get_analytics_summary

Pull clicks, referrers, geo, and device analytics.

list_templates

Browse the OG image template catalog.

get_user_profile

Fetch the authenticated user's profile and plan.

Connect your agent

Add Peeksy to your MCP client config (Claude Code, Cursor, Windsurf) and your agent can manage links without leaving the editor:

mcp.json

{
  "mcpServers": {
    "peeksy": {
      "url": "https://api.peeksy.space/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

AI systems can also discover Peeksy at /llms.txt.

Ready to start building?

Create your free account and have your first AI-powered link live in under a minute.