The Snip API

Getting started

The Snip API is one HTTPS host, https://snip.link. Every endpoint returns JSON and every error uses the same shape, so you can write one error handler and be done.

1. Create a key

Every account gets one, the free plan included. Sign up, then open API keys and create one. The key is shown once. Store it as an environment variable, never in source control.

2. Send it with every request

Use the Authorization header. If your client cannot set it, send the same value in X-API-Key instead.

Authorization: Bearer snip_live_4Qm7xB2vTnK9pLdW3sHc8YrJf6QaZ1eU5oM

3. Read the meta block

Every tool response is { result, meta }. The meta block carries meta.credits_charged, meta.balance, meta.latency_ms and meta.request_id. The request id is also in the X-Request-Id response header. Log it: it is the fastest way to get an answer about a specific call.

Errors

Every error is JSON with the same three fields, plus optional per-field details on validation failures.

{
  "code": "insufficient_credits",
  "message": "Your balance is 0 credits and this call costs 1. Buy a top-up or upgrade your plan.",
  "request_id": "b9d4d1a2-6a4e-4f1e-9d0a-1d2f3e4c5b6a"
}

Rate limits and credits

Each key has its own requests-per-second ceiling, counted in a sliding one-second window. Your plan sets the maximum; you can set a lower value per key, which is how most people keep a staging key from spending production budget.

Credits are shared across every key on the account and the website. What a run costs is part of each tool's description: QR code generator, 1 credit per code. Calls to /v1/usage and /v1/me are free.

Response headers

Model Context Protocol

AI agents call the same tools over MCP, with the same key, credits and limits. Set it up in Claude, Cursor and other clients.

/llms.txt describes the product and its API in plain text for agents that prefer to read rather than introspect, and /openapi.json is the machine-readable spec this page is generated from.

A scannable QR code as SVG for a link or text, in your style and colours.

Encodes a link or text as a static QR code and returns it as a standalone SVG. Picks the smallest version that fits, draws rounded or square modules in your colours, sets the error correction level and quiet zone, and reports the contrast between the colours with a warning when phones may struggle to scan it. Costs 1 credit per code. Input size is counted in characters; the per-run limit depends on the plan. Also available as the MCP tool snip_qr_code.

Request body

JSON, sent with Content-Type: application/json.

Example request

curl -s "https://snip.link/v1/qr_code" \
  -H "Authorization: Bearer $SNIP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":"https://snip.link/spring-menu?qr=1"}'

Errors

Current period usage

Balance and usage for the current UTC month, plus the calling key's own request count. Free to call.

Parameters

This endpoint takes no parameters.

Example request

curl -s "https://snip.link/v1/usage" \
  -H "Authorization: Bearer $SNIP_KEY"

Errors

Key metadata

Describes the calling key and its plan. Useful for verifying a key before shipping it in a deployment. Free to call.

Parameters

This endpoint takes no parameters.

Example request

curl -s "https://snip.link/v1/me" \
  -H "Authorization: Bearer $SNIP_KEY"

Errors

Schemas

The spec defines 7 schemas: QrCodeResponse, QrCodeResult, RunMeta, Error, QrCodeInput, UsageResponse, MeResponse. Generate a typed client from /openapi.json rather than hand writing types.