REST API v1

API Infrastructure
You Can Trust.

Programmatic URL shortening architecture built on Edge runtimes. Granular permissions via Read/Write Scoped API Keys ensure maximum security when embedded in your CI/CD pipelines or client-side apps.

Read The Docs

$ npm install @blinkurls/client

api.blink.url/v1/links

// 1. Client attempts to mutate state with a READ-ONLY Scoped API token

curl -X POST https://api.blink.url/v1/links \
  -H "Authorization: Bearer sk_live_v2...read_only_key" \
  -H "Content-Type: application/json" \
  -d '{"originalUrl": "https://stripe.com"}'

// 2. Platform intercepts and blocks the request at the Edge (0ms DB load)

HTTP/1.1 403 Forbidden22ms

{
  "error": "Forbidden",
  "message": "API Key lacks links:write scope.",
  "resolution": "Generate a Key with explicit WRITE permissions in Settings."
}

Zero-Trust by Default.

Competitors give you an omnipotent "all-access" token. We isolate risk by giving your development team surgical, scope-based permissions.

Scoped Read/Write Keys

Deploy a strict links:read key to your frontend analytics dashboards without exposing your underlying infrastructure to arbitrary link generation attacks.

Edge-Optimized Persistence

Architected against Prisma Connection Pool exhaustion utilizing strict pgBouncer proxying. We utilize NanoID cryptography out-of-the-box for conflict-free, high-throughput insertions.

Middleware Security Layer

Every request routed through the `v1` endpoint passes through our proprietary interceptor, evaluating HTTP payloads for malicious URIs and blacklisted domain schemas prior to database evaluation.

Predictable Data Structures.

Our API endpoints respond with highly standardized, heavily-typed payloads. Extract conversion metadata, verify TTL (Time-To-Live) constraints, and parse geographic click clusters using pure JSON.

Bulk link deletion Support
Passwords & Time-bomb integrations
Sub-10ms TTFB global routing

201 Created

// Response Payload

{
  "id": "link_x8f9Aaq1",
  "shortUrl": "https://blink.url/gh2Jx",
  "stats": {
    "clicks": 0,
    "isBurnOnRead": true
  },
  "expiresAt": "2026-10-31T23:59:59Z"
}

Start Building.

Generate a Scoped API key in the Dashboard settings right now to orchestrate your marketing flow securely.

Generate Scoped Key