The ShortURL.bot public API is a server-to-server interface for workspace links, QR codes, pages, insights, usage, forms, and conversions. It uses the same subscription entitlements and usage counters as the web dashboard, so an API call does not bypass a plan limit or create a separate API-only allowance.
1. Create and scope an API key
Create a key in Settings → API keys. Keys are available on every subscription tier, belong to a subscription, and can be scoped to all workspaces or selected workspaces. Copy the secret when it is shown and store it in a server-side secret manager—never in browser JavaScript, a mobile binary, source control, or logs.
The production base URL is https://api.shorturl.bot/v1. Send Authorization: Bearer <api_key>, then call GET /workspaces to discover the workspace identifiers the key can access.
2. Create a link in a workspace
curl -X POST "https://api.shorturl.bot/v1/workspaces/WORKSPACE_ID/links" -H "Authorization: Bearer $SHORTURL_API_KEY" -H "Content-Type: application/json" -d '{"targetUrl":"https://example.com/launch","backHalf":"launch","tags":["email"]}'A successful create returns 201 with the link resource. Omit domain to use the platform default. Retired first-party domains such as 2s.gg are legacy-only and rejected for new resources.
3. Design around entitlements and failures
- Every plan: API keys, ordinary link creation, tags, UTM fields, and custom back-halves, subject to the active subscription-period quota.
- Go or higher: status control and bulk creation. A bulk request accepts up to 500 items and consumes the normal link quota.
- Plus or higher: destination updates, scheduling, expiry, after-expiry redirect, and password protection.
- System limit: 800 public API requests per IP per minute in addition to plan quotas.
Handle error.code and error.message. 401 means the key is missing or invalid, 403 means workspace, feature, data, or parameter access was denied, and 429 means a quota or rate limit. Retry only transient failures with bounded exponential backoff.
Next steps
Use the maintained ShortURL.bot developer reference for complete schemas and error contracts.