URL Shortener — create and resolve short links

URL Shortener API

What it does

URL Shortener lets you create short links from absolute http or https URLs, then resolve those codes back to the original destination. Send a url in the request body and get back a response with a code, short_url, long_url, permanent, and, when applicable, expires_at.

Use permanent when you want a link that never expires. When permanent is false, the response may include an expiry timestamp; when it is true, expires_at is omitted. The generated short URL includes the /service/u/{code} path, so you can store or share it directly without building the link yourself.

This is a good fit for product analytics, share links, campaign redirects, and internal tooling where you need a stable short alias for a longer destination. On the redirect endpoint, send the code in the path and the service returns an empty response after routing the user to the original URL.

curl -X POST "http://localhost:8080/pankajretestflows/mono-go-url-shortener-api" \ -H "apy-token: $APY_TOKEN" \ -H "Content-Type: application/json" \ -d '{"url":"https://apyhub.com/docs/url-shortener"}'

{ "data": { "code": "aB3xY7z", "short_url": "{{AMBER_REGION_URL}}/pankajretestflows/mono-go-url-shortener-api", "long_url": "https://apyhub.com/docs/url-shortener", "permanent": false, "expires_at": "2026-07-20T10:00:00Z" } }

About this endpoint

What it does

Creates a shortened link from a long URL and returns the generated short link details. The request takes the destination URL, and the response returns the original URL plus the generated code, fully qualified short URL, and permanence flag.

Request Body

Parameter	Type	Mandatory	Description
url	String	Yes	Absolute URL to shorten. Must be a valid URI using `http` or `https`.
permanent	Boolean	No	When `true`, the link never expires. Default: `false`. If `true`, `expires_at` is omitted in the response.

Response

Returns a JSON object with a data object field. The data object contains the generated short-link details: code as a string, short_url as a URI string, long_url as a URI string, permanent as a boolean, and expires_at as a nullable date-time string when present. Success response: 200.

Parameter	Type	Mandatory	Description
data	Object	Yes	Container for the generated short-link details.
data.code	String	Yes	Random 7-character base62 code.
data.short_url	String	Yes	Fully qualified short URL including `/service/u/{code}`.
data.long_url	String	Yes	The original long URL that was shortened. Must be a valid URI.
data.permanent	Boolean	Yes	Indicates whether the link is permanent.
data.expires_at	String	No	Absolute expiry timestamp in date-time format. Nullable. Omitted for permanent links.

Body

Name

Type

Description

bodyREQUIRED

object

—

About this endpoint

What it does

Redirects a short URL code to its corresponding long URL. The request takes a path code and the endpoint returns a minimal acknowledgement on success; the detailed response shape is not yet captured in the schema.

Path Parameter(s)

Attribute	Type	Mandatory	Description
code	String	Yes	Short URL code, 1 to 10 alphanumeric characters (`^[A-Za-z0-9]{1,10}$`).

Response

The endpoint returns a minimal acknowledgement on success — the detailed shape is not yet captured in the schema.

URL Shortener API

What it does

QUICKSTART

Quickstart

What you'll get back

About this endpoint

What it does

Request Body

Response

Body

QUICKSTART

Quickstart

What you'll get back

About this endpoint

What it does

Path Parameter(s)

Response

Path parameters

Errors any endpoint can return