MiniURL shorten_url
shorten_urlCreate a MiniURL short link for a supplied HTTP or HTTPS destination. Use when the user asks to shorten a URL or generate a MiniURL link. This is an additive external write; do not fetch or open the destination. If no authentication is supplied, MiniURL automatically starts a guest flow. Reuse idempotency_key when retrying the same logical request.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The HTTP or HTTPS destination URL to shorten. | |
| alias | No | Optional custom alias. Call check_alias before creating it. Requires a registered account; miniurl.com aliases must be at least 4 characters. | |
| domain | No | Optional domain. Requires a registered account with an active custom domain. | |
| dry_run | No | Validate the destination and show the planned link without creating it. Agent tokens only. | |
| password | No | Optional password. Requires Pro. | |
| expiration | No | Optional ISO 8601 expiration datetime. Requires Pro. | |
| activated_at | No | Optional ISO 8601 activation datetime. Requires Pro. | |
| idempotency_key | No | Optional idempotency key. Reusing it with the same payload safely replays the original result. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| meta | No | ||
| error | No | ||
| success | Yes | ||
| approval | No | ||
| retryable | No | ||
| request_id | Yes | ||
| retry_after | No | ||
| next_actions | No | ||
| required_scope | No | ||
| user_action_required | No |