Skip to main content
POST
/
urls
Create a new short URL
curl --request POST \
  --url https://pref.rio/link/api/urls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "A great website",
  "destination": "https://example.com",
  "expires_at": "2024-12-31T23:59:59Z",
  "image_url": "https://example.com/image.jpg",
  "short_path": "custom-path",
  "title": "My Website"
}'
{
  "created_at": "2024-01-01T12:00:00Z",
  "description": "A great website",
  "destination": "https://example.com",
  "expires_at": "2024-12-31T23:59:59Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "image_url": "https://example.com/image.jpg",
  "short_path": "abc123",
  "title": "My Website",
  "updated_at": "2024-01-01T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

URL creation request

​
destination
string
required
Example:

"https://example.com"

​
description
string
Example:

"A great website"

​
expires_at
string
Example:

"2024-12-31T23:59:59Z"

​
image_url
string
Example:

"https://example.com/image.jpg"

​
short_path
string
Example:

"custom-path"

​
title
string
Example:

"My Website"

Response

Created

​
created_at
string
Example:

"2024-01-01T12:00:00Z"

​
description
string
Example:

"A great website"

​
destination
string
Example:

"https://example.com"

​
expires_at
string
Example:

"2024-12-31T23:59:59Z"

​
id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
image_url
string
Example:

"https://example.com/image.jpg"

​
short_path
string
Example:

"abc123"

​
title
string
Example:

"My Website"

​
updated_at
string
Example:

"2024-01-01T12:00:00Z"