Developer Reference

API Documentation

Programmatically interface with our edge compression layers. Authenticate your terminal hooks and integrate core URL operations smoothly.

1. Shorten a Destination Target URL

Issue an authenticated HTTP POST request to the link optimization handler to provision short hashes.

POST /api/shortenapplication/json

// Request Payload Contract

{

"destination": "https://github.com",

"customCode": "launch-promo" // Optional

}

ParameterTypeDescription
destinationstringRequired. Absolute target URL routing path. Must be fully valid string.
customCodestringOptional. Custom string back-half alias. Alphanumeric characters only, max 16 chars.

Expected Output Envelope

Response Status201 Created

{

"shortCode": "launch-promo",

"destination": "https://github.com/jeesanabbas/proximely/deep/ref",

"createdAt": "2026-06-28T14:53:00Z"

}