Skip to main content
POST
Shorten Long URLs
curl --request POST \
  --url https://spoo.me/ \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data url=https://example.com \
  --data alias=example \
  --data password=SuperStrongPassword@18322 \
  --data max-clicks=10 \
  --data block-bots=false
{
  "short_url": "https://spoo.me/example",
  "domain": "spoo.me",
  "original_url": "https://example.com"
}

Headers

​
Accept
enum<string>
default:application/json
required

Must be set to application/json to receive JSON responses

Available options:
application/json

Body

application/x-www-form-urlencoded
​
url
string<uri>
required

The long URL to be shortened. Must include a valid protocol (http/https) and follow RFC-1034 & RFC-2727 standards.

Example:

"https://example.com"

​
alias
string

Custom alias for the shortened URL. Must be alphanumeric and maximum 16 characters. Anything beyond 16 characters will be stripped by the API.

Maximum string length: 16
Pattern: ^[a-zA-Z0-9]+$
Example:

"example"

​
password
string

Password to access the shortened URL. Must be at least 8 characters long, contain at least one letter, one number, and one special character ('@' or '.').

Minimum string length: 8
Example:

"SuperStrongPassword@18322"

​
max-clicks
integer

Maximum number of clicks allowed for the shortened URL. Must be a positive integer.

Required range: x >= 1
Example:

10

​
block-bots
boolean

Whether to block bots from accessing the shortened URL.

Example:

false

Response

URL successfully shortened

​
short_url
string<uri>

The shortened URL

Example:

"https://spoo.me/example"

​
domain
string<host>

The domain of the shortened URL

Example:

"spoo.me"

​
original_url
string<uri>

The original URL

Example:

"https://example.com"