API and SDK

This is the minimal verified documentation. The complete documentation, per-language examples and Forklink's test environment will be published when the service opens.

OpenAPI specification

The link product serves its OpenAPI 3 specification at /openapi.json (header Cache-Control: public, max-age=300) and an interactive reference at /docs. It covers links, domains, tags, groups, UTM, webhooks, mobile apps and deep links, analytics, conversions and link pages.

Coming soon: the public address of Forklink's specification (planned at api.forklink.co) will be published when we open. It does not exist yet.

The API reference is generated from the real OpenAPI and its examples were run against staging.

JavaScript/TypeScript SDK

npm install @customyai/links @customyai/core

Authenticate with a cl_live_… or cl_test_… key, or with machine tokens. It retries reads and deletes on network errors, 429 and 5xx; a POST is not repeated automatically. Verify webhooks with verifyWebhook(rawBody, headers, secret).

Actual package status (npm, checked 2026-11-09)

• @customyai/links — recommended. Published: 0.1.3. The repository has 0.2.0 (mobile apps and deep links v2), unpublished.
• @customyai/links-sdk — deprecated. Published: 0.3.3. The repository marks the package as deprecated (0.4.0 unpublished, an adapter over @customyai/links); do not use it in new projects.
• Forklink's own package name is still to be decided; no package called Forklink exists today.

• Public address of Forklink's specification and interactive reference.
• Per-language examples and a quick-start guide with test keys.
• Usage limits per plan (they depend on pricing, which is not approved).
• Service status (status.forklink.co).