API documentation
POST /shorten
Request body
{
"security": [
{
"apiKey": []
}
],
"summary": "Create a short link",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string",
"format": "uuid"
},
"long_url": {
"type": "string",
"maxLength": 8192,
"format": "uri"
},
"back_half": {
"type": "string",
"default": ""
},
"domain_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"default": null
},
"title": {
"type": "string",
"maxLength": 300,
"default": ""
},
"tags": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 100,
"default": []
},
"campaign_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"default": null
},
"utm": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 300
},
"propertyNames": {
"enum": [
"utm_source",
"utm_medium",
"utm_campaign",
"utm_term",
"utm_content"
]
},
"default": {}
},
"expires_at": {
"type": "string",
"default": ""
},
"expired_redirect_url": {
"anyOf": [
{
"type": "string",
"maxLength": 8192,
"format": "uri"
},
{
"type": "string",
"const": ""
}
],
"default": ""
},
"password": {
"type": "string",
"maxLength": 72,
"default": ""
},
"remove_password": {
"type": "boolean",
"default": false
},
"deep_link": {
"type": "object",
"properties": {
"ios": {
"type": "string",
"maxLength": 2048
},
"android": {
"type": "string",
"maxLength": 2048
},
"ios_fallback": {
"anyOf": [
{
"type": "string",
"maxLength": 8192,
"format": "uri"
},
{
"type": "string",
"const": ""
}
],
"default": ""
},
"android_fallback": {
"anyOf": [
{
"type": "string",
"maxLength": 8192,
"format": "uri"
},
{
"type": "string",
"const": ""
}
],
"default": ""
}
},
"additionalProperties": false,
"default": {}
},
"routing_rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 100,
"default": ""
},
"region": {
"type": "string",
"maxLength": 100,
"default": ""
},
"device_type": {
"type": "string",
"enum": [
"",
"mobile",
"desktop",
"tablet",
"bot"
],
"default": ""
},
"platform": {
"type": "string",
"enum": [
"",
"iOS",
"Android",
"Windows",
"macOS",
"Linux"
],
"default": ""
},
"language": {
"type": "string",
"maxLength": 20,
"default": ""
},
"start": {
"type": "string",
"maxLength": 40,
"default": ""
},
"end": {
"type": "string",
"maxLength": 40,
"default": ""
},
"destination": {
"type": "string",
"maxLength": 8192,
"format": "uri"
}
},
"required": [
"destination"
],
"additionalProperties": false
},
"maxItems": 20,
"default": []
},
"parameter_passing": {
"type": "boolean",
"default": false
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"has_qr": {
"type": "boolean",
"default": false
},
"page_attachment_requested": {
"type": "boolean",
"default": false
},
"sms_optimized": {
"type": "boolean",
"default": false
}
},
"required": [
"group_id",
"long_url"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {}
}
}
}
}
},
"429": {
"description": "Monthly quota or per-second limit reached"
}
}
}curl -X POST '/shorten' \
-H 'Authorization: Bearer $API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"group_id": "",
"long_url": "https://example.com",
"title": "Example"
}'Agent connections
Claude, ChatGPT, Copilot and Perplexity: use a custom MCP connection where your client supports remote OAuth servers. Availability varies by client and subscription.
Connect using the endpoint above, sign in, and review the requested account access. Never paste a session token into an assistant.