Skip to Content
S.EE Docs
API Reference

Create Short URL

Creates a short URL for a destination link. Optional settings include a custom slug, password, expiration time, and tags.

POST
/api/v1/shorten

Header Parameters

Authorization*string

Your API key

Request Body

Short URL configuration

application/json
  1. body
custom_slug?string

Your preferred custom slug (e.g., "my-link"). If not provided, a random slug will be generated.

Lengthlength <= 255
domain*string

The domain to use for your short URL (e.g., "s.ee")

Lengthlength <= 255
Default"s.ee"
expiration_redirect_url?string

URL to redirect visitors to after this short link expires

Lengthlength <= 2000
expire_at?integer

Unix timestamp when this short link should expire (e.g., 1735689600)

password?string

Optional password to protect this short link (3-32 characters)

Length3 <= length <= 32
tag_ids?array<integer>

Array of tag IDs to organize this link (get available tags via /api/v1/tags)

target_url*string

The destination URL you want to shorten (required)

Lengthlength <= 2000
title?string

A descriptive title for this short link (for your reference)

Lengthlength <= 255

Response Body

OK

application/json
  1. response
code?integer

Response status code (200 indicates success)

data?

Short URL creation response

message?string

Human-readable status message

Example Request
curl -X POST 'https://s.ee/api/v1/shorten' \  -H 'Authorization: string' \  -H 'Content-Type: application/json' \  -d '{  "domain": "s.ee",  "target_url": "string"}'
Example Response200
{  "code": 0,  "data": {    "custom_slug": "string",    "short_url": "string",    "slug": "string"  },  "message": "string"}
⌂