API Reference

Everything you need to integrate Peeksy into your stack. RESTful JSON API with JWT authentication.

Authentication

All API requests require a Bearer token. Generate one from your dashboard under Settings → API Keys.

terminal

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.peeksy.space/links

GET/links

List all links

POST/links

Create a short link

GET/links/:id

Get link details

PATCH/links/:id

Update a link

DELETE/links/:id

Delete a link

POST/og/generate

Generate an OG image for a link

GET/og/:linkId

Get the current OG image

Method	Endpoint	Description
POST	/og/generate	Generate an OG image for a link
GET	/og/:linkId	Get the current OG image

POST/seo/:linkId/audit

Run an SEO audit on the destination

GET/seo/:linkId/audit

Get the latest audit result

Method	Endpoint	Description
POST	/seo/:linkId/audit	Run an SEO audit on the destination
GET	/seo/:linkId/audit	Get the latest audit result

GET/analytics/:linkId

Get click analytics for a link

GET/analytics/summary

Summary across all links

Method	Endpoint	Description
GET	/analytics/:linkId	Get click analytics for a link
GET	/analytics/summary	Summary across all links

TypeScript SDK for Node.js, browsers, and edge runtimes. Covers all API endpoints with full type safety.

npm install @peeksy/sdk

Connect Claude, Cursor, or any MCP-compatible AI agent to manage links and fetch analytics.

See Integrations for setup instructions.