Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

Short Links API

Branded short URLs for messages and campaigns — https://orb.li/abc123-style. The redirect handler (GET /l/:code) is mounted at the root of the API host and is rate-limited to 60 req/min per IP. Click data is captured asynchronously and exposed via the stats endpoint. Base path: /v1/links (management) — public redirect at https://orbit-api.devotel.io/l/{code} Authentication: API key (X-API-Key) or session JWT for management; the redirect itself is anonymous.
MethodPathPurpose
POST/v1/links/Create a short link
GET/v1/links/List short links
GET/v1/links/{id}/statsPer-link click stats
DELETE/v1/links/{id}Delete a short link

Example — shorten a URL

curl -X POST https://orbit-api.devotel.io/api/v1/links/ \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "destination": "https://example.com/promo?utm_campaign=may26",
    "domain": "orb.li",
    "metadata": { "campaign": "may26" }
  }'
The response includes the full short URL — embed it directly in outbound messages.

See also