Shorten URL
shorten_urlShorten a long URL. Deduplicates automatically — shortening the same URL twice returns the existing link. Every link is namespace-aware: every user gets a prefix, so stats are kept if the plan changes. Supports routing rules, OG meta, geo-restriction, password protection, and ad-click-ID passthrough (available on Pro plans and higher).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"url": "<url>"
},
"name": "shorten_url"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The long URL to shorten (http or https) | |
| og_meta | No | Override Open Graph tags for social media previews. Pro+. | |
| password | No | Optional password to protect this link (min 4 chars). Visitors must enter the password before being redirected. Pro+. | |
| expires_at | No | Optional ISO-8601 expiry datetime, e.g. "2026-12-31T23:59:59Z" | |
| max_clicks | No | Optional click cap — link deactivates after this many clicks | |
| custom_slug | No | Optional human-readable slug, e.g. "product-launch". Requires a Starter plan or higher. | |
| override_scan | No | When true, creates the link even if the URL trust score is below the safety threshold (score < 40). Use with caution — the link is saved disabled and does not redirect until it has been reviewed. | |
| routing_rules | No | Conditional routing: redirect visitors to different destinations based on device, OS, country, or language. Pro+ (5 rules), Builder+ (20 rules). | |
| geo_restriction | No | Allow or block access by country. Pro+. | |
| pass_ad_click_ids | No | When true, appends gclid/fbclid/ttclid parameters from the original click to the destination URL. | |
| expire_fallback_url | No | Optional URL to redirect visitors to when this link expires, instead of showing the expiry error page. Must not create a circular redirect. Pro+ only. |