Shorten a URL

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

URL to shorten

Formaturi

workspace_id?string

Workspace for the short link. Omit for organization scope when workspace IDs are optional.

curl -X POST "https://example.com/v1/short-links/shorten" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'

{  "original_url": "string",  "short_url": "string"}

Found something wrong? Help us improve this page.

List short links for a post GET

Test short link configuration POST

Test the configured provider with a read-only credential probe. No remote link is created.