Lix.li JavaScript SDK

// Create a basic link
const result = await client.links().create('https://example.com');

// With custom alias and UTM
const result = await client.links().create(
    'https://example.com',
    'summer-sale',           // alias
    'My Summer Sale',        // title
    null,                    // groupId
    ['marketing', '2026'],   // tags
    [],                      // meta
    {                        // utm
        source: 'newsletter',
        medium: 'email',
        campaign: 'summer-sale',
    },
    [1, 2],                 // trackingPixelIds
    null,                    // activeBeforeDatetime
    null,                    // password
    true                     // isPublic
);

// Password protection + expiration
const result = await client.links().create(
    'https://example.com',
    null, null, null, [], [], [], [],
    '2026-12-31T23:59:59Z',  // activeBeforeDatetime
    'secret123'              // password
);

// Create a regular group
const group = await client.groups().create('Marketing');
console.log(group.name);

// Create a rotating group for A/B testing
const group = await client.groups().create(
    'Landing Pages',
    null,
    true   // isRotate
);

// Update group
const group = await client.groups().update(
    10,
    null,
    'Updated description'
);

// List with pagination
const response = await client.groups().list(10, 1000);
for (const group of response.groups) {
    console.log(group.name);
}

const profile = await client.profile().me();

// Account info
console.log(profile.client.name, profile.client.email);
console.log(profile.user.email);

// Plan details
console.log(profile.plan.name, profile.plan.endDatetime);

// Usage limits
console.log(profile.usages.links.remaining);
console.log(profile.usages.apiLinks.used);
console.log(profile.usages.massLinks.limit);

const {
    ValidationException,
    NotFoundException,
    UnauthorizedException,
    RateLimitException,
    ServerException
} = require('lix-url');

try {
    await client.links().create('invalid-url');
} catch (err) {
    if (err instanceof ValidationException) {
        // Field-level validation errors
        console.error('Validation:', err.data);
    } else if (err instanceof NotFoundException) {
        console.error('Not found:', err.message);
    } else if (err instanceof UnauthorizedException) {
        // Invalid API key
    } else if (err instanceof RateLimitException) {
        // Too many requests — retry after
    } else if (err instanceof ServerException) {
        // 5xx server error
    } else {
        // Generic Lix or network error
        console.error('Error:', err.message);
    }
}