Links

Create a short link

Works with gt_, mk_, and scoped at_ Agent tokens. With gt_, only url is applied; alias, domain, password, expiration, and activated_at are ignored and returned in meta.notices. OAuth Agents may send dry_run=true to preview a redirect without writing it.

post/api/v1/shorten

Request

  • Base URL: https://workers.miniurl.com
  • URL: https://workers.miniurl.com/api/v1/shorten
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

Idempotency-Keystring

8-128 ASCII characters. Same key and payload safely replay the original result.

Request body

urlstring uri required
aliasstring

4-64 characters on miniurl.com; 1-64 characters on a verified custom domain.

domainstring
passwordstring
expirationstring date-time
activated_atstring date-time
dry_runboolean

OAuth Agent only: validate policy, safety, alias, and domain availability without creating the link.

Response

Short link created

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.