API documentation

Bearer key auth · No login · JSON responses

Use the DotGLinks API to generate trusted short links from your app or server. You receive an API key by email after purchasing a plan on the pricing page. See also API terms.

Base URL

https://dotglinks.com/api/v1

Authentication

Send your key on every request:

Authorization: Bearer tr_live_your_key_here

Or as a fallback header: X-Api-Key: tr_live_your_key_here

Generate links

POST /api/v1/generate

curl -X POST https://dotglinks.com/api/v1/generate \
  -H "Authorization: Bearer tr_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","count":5}'

Body fields: url (required), count (optional, default 1, max depends on plan), qr (optional boolean — when true, also returns PNG QR codes as data URLs, same order as links).

Success example:

{
  "ok": true,
  "links": ["https://example.com/r/..."],
  "count": 5,
  "usage": { "links_used": 5, "links_remaining": 23995, "plan": "starter" }
}

With QR codes ("qr": true):

curl -X POST https://dotglinks.com/api/v1/generate \
  -H "Authorization: Bearer tr_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","count":1,"qr":true}'
{
  "ok": true,
  "links": ["https://example.com/r/..."],
  "qr": ["data:image/png;base64,..."],
  "count": 1,
  "usage": { "...": "..." }
}

Each qr[i] matches links[i]. Decode the base64 (after the comma) to get a PNG file. Omit qr or set it to false if you don’t need images (smaller response).

Check usage

GET /api/v1/usage

curl https://dotglinks.com/api/v1/usage \
  -H "Authorization: Bearer tr_live_xxx"

Returns plan, monthly used/remaining, max per request, rate limit, and expiry.

Plan limits

Defaults match pricing:

  • Lite: 5,000 / month · 25 / request · 50 links / minute
  • Starter: 24,000 / month · 25 / request · 100 links / minute
  • Growth: 65,000 / month · 50 / request · 300 links / minute
  • Scale: 149,000 / month · 100 / request · 500 links / minute
  • Unlimited: custom (agreed when you contact us)

Monthly usage resets every month from your plan start date.

Error codes

  • missing_key / invalid_key: 401
  • expired / key_paused / key_revoked: 403
  • invalid_url / max_per_request: 400
  • quota_exceeded / rate_limit / job_lock: 429
  • generate_failed / server_error: 5xx

Get a key

Pick a plan on API pricing, then email us with your email and plan. We’ll send your key, limits, and expiry. Keep the key secret. Common questions are answered in the API FAQ.