Ulinkly OpenAPI specification

Ulinkly publishes a machine-readable OpenAPI 3.1 contract at:

https://ulink.ly/openapi.json

The contract includes unique operation IDs, typed parameters and request bodies, response schemas, authentication requirements, and public no-auth operations. AI agents and code generators can use it to create function definitions or typed API clients.

Download the contract

curl -L https://ulink.ly/openapi.json -o ulinkly-openapi.json

The production API server is https://api.ulink.ly/v1. The deprecated unversioned compatibility server is listed second with a link to the versioning policy. Operations that require a project credential declare the X-App-Key security scheme; public health, plan discovery, and deep-link resolution operations explicitly declare no authentication. Every documented 4xx and 5xx response references the shared RFC 9457 typed error, and response headers describe the rate-limit contract.

The same interfaces are listed in Ulinkly's RFC 9727 API catalog. For integration order and request examples, continue with the Direct Integration Guide.