API reference
Public API
The Operlyx Links API is available on the Pro plan. Create links, fetch QR assets, and read reports programmatically.
Authentication
Create an API key from your dashboard settings. Send it as a bearer token on every request. Keys are shown once at creation — store them securely. Requests from Free or lapsed-Pro workspaces are rejected.
Authorization: Bearer olx_live_<your_key>Base URL
https://api.link.operlyx.comEndpoints
| POST | /api/v1/links | Create a short link |
| GET | /api/v1/links | List your links |
| GET | /api/v1/links/:id | Fetch a single link |
| PATCH | /api/v1/links/:id | Update destination or expiration |
| DELETE | /api/v1/links/:id | Delete (retire) a link |
| GET | /api/v1/links/:id/qr.svg | Download the QR as SVG |
| GET | /api/v1/links/:id/qr.png | Download the QR as PNG |
| GET | /api/v1/links/:id/report | Fetch the combined report |
Example: create a link
curl -X POST https://api.link.operlyx.com/api/v1/links \
-H "Authorization: Bearer olx_live_your_key_here" \
-H "Content-Type: application/json" \
-d '{"targetUrl":"https://example.com/campaign"}'
The response returns the link with its shortUrl and
slug. Use the same id
to fetch QR assets and reports.
Manage your API keys in dashboard settings.