Build anything
on top of your links

# POST /api/v1/workspaces/{workspace}/links — shorten a URL
curl -X POST {{APP_URL}}/api/v1/workspaces/1/links \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "original_url": "https://example.com/very/long/url",
    "custom_alias": "my-campaign",
    "expires_at": "2026-12-31 23:59:59",
    "tags": ["marketing", "q4"]
  }'

# 201 Created
{
  "data": {
    "id": 4821,
    "short_url": "{{APP_URL}}/my-campaign",
    "clicks": 0,
    "created_at": "2026-04-20T10:32:00Z"
  }
}

const res = await fetch(`{{APP_URL}}/api/v1/workspaces/${workspaceId}/links`, {
  method:  'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SHORTLINK_API_TOKEN}`,
    'Content-Type': 'application/json',
    'Accept':       'application/json',
  },
  body: JSON.stringify({
    original_url: 'https://example.com/very/long/url',
    custom_alias: 'my-campaign',
    expires_at:   '2026-12-31 23:59:59',
    tags:         ['marketing', 'q4'],
  }),
})

const { data } = await res.json()
console.log(data.short_url) // {{APP_URL}}/my-campaign

import os, requests

res = requests.post(
    f"{{APP_URL}}/api/v1/workspaces/{workspace_id}/links",
    headers={
        "Authorization": f"Bearer {os.environ['SHORTLINK_API_TOKEN']}",
        "Accept":        "application/json",
    },
    json={
        "original_url": "https://example.com/very/long/url",
        "custom_alias": "my-campaign",
        "expires_at":   "2026-12-31 23:59:59",
        "tags":         ["marketing", "q4"],
    },
)

print(res.json()["data"]["short_url"])  # {{APP_URL}}/my-campaign

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('SHORTLINK_API_TOKEN'))
    ->acceptJson()
    ->post("{{APP_URL}}/api/v1/workspaces/{$workspaceId}/links", [
        'original_url' => 'https://example.com/very/long/url',
        'custom_alias' => 'my-campaign',
        'expires_at'   => '2026-12-31 23:59:59',
        'tags'         => ['marketing', 'q4'],
    ]);

echo $response->json('data.short_url'); // {{APP_URL}}/my-campaign