Skip to main content
POST
links.short.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
string
required

The link-shortening app to create the link in, e.g. "bitly" or "dub".

Pattern: ^[a-z0-9_-]{1,64}$
destinationUrl
string
required

The long URL to shorten. Plain http or https only; no credentials in the URL.

slug
string

Custom slug for the short link, e.g. "launch". Only where the app supports it.

Pattern: ^[A-Za-z0-9_-]{1,128}$
domain
string

Custom domain for the short link, e.g. "go.example.com". Only where the app supports it.

Pattern: ^(?=.{1,253}$)[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)+$

Response

The result

shortUrl
string
required

The short URL. Share this.

destinationUrl
string
required

Where the short link sends people.

slug
string

The slug (the part after the domain).

createdAt
string

When the link was created, ISO 8601.

clicks
number

Total clicks on the link.

ref
string

Reference to what this call created. Pass it as ref to links.short.get, links.short.clicks.get, links.short.update or links.short.delete.