Flyn

{'type': 'object', 'required': ['type'], 'properties': {'bg': {'type': 'string', 'description': 'Background colour as 6-digit hex, default #FFFFFF. Requires Flyn Pro.'}, 'fg': {'type': 'string', 'description': 'Foreground colour as 6-digit hex, default Flyn green #14532D. Requires Flyn Pro.'}, 'url': {'type': 'string', 'description': "For type 'url': the URL to encode."}, 'size': {'type': 'integer', 'maximum': 2048, 'minimum': 64, 'description': 'Maximum width in pixels, 64 to 2048, default 512. The image is the largest whole-module square that fits, so the real width is usually slightly smaller and is reported back.'}, 'text': {'type': 'string', 'description': "For type 'text': the plain text to show when scanned."}, 'type': {'enum': ['url', 'text', 'vcard', 'email', 'phone', 'sms'], 'type': 'string', 'description': "What to encode. 'url' and 'text' work on any plan. 'vcard', 'email', 'phone' and 'sms' require Flyn Pro."}, 'email': {'type': 'string', 'description': "For type 'email': the recipient address."}, 'level': {'enum': ['L', 'M', 'Q', 'H'], 'type': 'string', 'description': "Error correction level: 'L', 'M' (default), 'Q' or 'H'. Higher levels survive more damage but make the symbol denser."}, 'phone': {'type': 'string', 'description': "For type 'phone': the number to dial. Include the country code, for example +15551234567, or the code only works for people dialling from the same country."}, 'vcOrg': {'type': 'string', 'description': "For type 'vcard': organisation or company."}, 'vcUrl': {'type': 'string', 'description': "For type 'vcard': website URL."}, 'format': {'enum': ['png', 'svg'], 'type': 'string', 'description': "Output format: 'png' (default) or 'svg'. SVG requires Flyn Pro."}, 'margin': {'type': 'integer', 'maximum': 32, 'minimum': 4, 'description': 'Quiet zone in modules. Minimum and default is 4, as required by ISO/IEC 18004; smaller values are raised to 4 because a short quiet zone is the most common cause of a printed code failing to scan.'}, 'vcName': {'type': 'string', 'description': "For type 'vcard': the person's full name. Required for a v-card."}, 'smsBody': {'type': 'string', 'description': "For type 'sms': the pre-filled message. The sender still has to press send."}, 'vcEmail': {'type': 'string', 'description': "For type 'vcard': email address."}, 'vcPhone': {'type': 'string', 'description': "For type 'vcard': phone number. Include the country code, for example +15551234567."}, 'smsPhone': {'type': 'string', 'description': "For type 'sms': the number to text. Include the country code."}, 'emailBody': {'type': 'string', 'description': "For type 'email': pre-filled message body."}, 'emailSubject': {'type': 'string', 'description': "For type 'email': pre-filled subject line."}}, 'additionalProperties': False}

{'type': 'object', 'required': ['url'], 'properties': {'url': {'type': 'string', 'description': 'The destination URL to shorten (https:// is assumed if no protocol is given).'}, 'slug': {'type': 'string', 'description': 'Optional custom slug (letters, numbers, hyphens, underscores; max 100 chars). A random slug is generated when omitted.'}, 'tags': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Optional tags for organizing links (Pro plan only).'}, 'title': {'type': 'string', 'description': 'Optional human-readable title for the link.'}, 'domain': {'type': 'string', 'description': 'Optional custom domain to mint the link on (must be a verified domain you own; Pro plan only). Omit to use your account default domain.'}, 'rotation': {'type': 'array', 'items': {'type': 'object', 'required': ['url', 'weight'], 'properties': {'id': {'type': 'string', 'description': "Stable identifier for this destination, recorded as the click variant on each click. Omit it on a brand new destination and Flyn mints one. When editing, send every existing destination back with the id it already has: click history is attributed by id, so a changed id detaches that destination's past clicks and a reused id merges two destinations' stats. Never derive ids from list position."}, 'url': {'type': 'string', 'description': 'Destination URL for this entry. Scanned with Google Safe Browsing like the primary destination.'}, 'label': {'type': 'string', 'description': 'Optional human-readable name for this destination. Cosmetic, it does not affect routing.'}, 'weight': {'type': 'number', 'minimum': 0, 'description': 'Relative share of traffic, NOT a percentage. Weights are normalised across the list, so [3, 1] sends roughly three quarters of clicks to the first entry and equal weights give an even split. A weight of 0 keeps the destination in the list without ever serving it.'}}, 'additionalProperties': False}, 'maxItems': 12, 'description': 'Optional weighted rotation of destinations, one short link splitting traffic between several URLs (Pro plan only). Up to 12 destinations; sending more is rejected rather than truncated, so nothing is dropped without telling you. Each human visitor is sent to one destination drawn at random in proportion to its weight, so the split settles over many clicks rather than following a strict order. Bots and crawlers always get the primary url, which stays required. Each click records the id of the destination that served it, and that id, not the url and not the list position, is what per-destination stats are keyed on. The Flyn dashboard does report them: the link\'s own analytics page has a "Destination Performance" panel listing every destination with its click count, its actual share of clicks, and the share its weight intended, and it keeps showing a destination you later remove from the rotation. No API or MCP call returns that breakdown, or the per-click destination id, so send the user to that page rather than inventing a tool call for it. The panel counts clicks only, across the clicks that carry a destination id: no conversion or revenue split, and no winner declared. Every destination is Safe Browsing scanned before the link is created.'}, 'expiresAt': {'type': 'string', 'description': 'Optional ISO 8601 datetime after which the link stops redirecting.'}, 'clickLimit': {'type': 'integer', 'minimum': 1, 'description': 'Optional maximum number of human clicks before the link stops redirecting (Pro plan only).'}, 'fallbackUrl': {'type': 'string', 'description': 'Optional URL visitors are sent to after the click limit is reached (Pro plan only).'}, 'forwardParams': {'type': 'boolean', 'description': 'Whether query parameters appended to the short link are forwarded to the destination. Defaults to true.'}, 'conversionTracking': {'type': 'boolean', 'description': 'Enable per-link conversion tracking (Pro plan only). The redirect then appends an unguessable click id to the destination URL, and the link reports conversions and total conversion value next to its clicks. Nothing is reported until the Flyn tag (or a server-to-server postback) is installed on the destination site, so tell the user that setup step is still theirs.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'The link id to delete.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'The link id (from create_short_link or list_links).'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'The link id.'}, 'page': {'type': 'integer', 'default': 1, 'minimum': 1, 'description': 'Page number, starting at 1.'}, 'limit': {'type': 'integer', 'default': 50, 'maximum': 200, 'minimum': 1, 'description': 'Click events per page (max 200 via MCP).'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['id'], 'properties': {'bg': {'type': 'string', 'description': 'Background colour as 6-digit hex, default #FFFFFF. Requires Flyn Pro.'}, 'fg': {'type': 'string', 'description': 'Foreground colour as 6-digit hex, default Flyn green #14532D. Requires Flyn Pro.'}, 'id': {'type': 'string', 'description': 'The id of the link to render a QR code for.'}, 'size': {'type': 'integer', 'maximum': 2048, 'minimum': 64, 'description': 'Maximum width in pixels, 64 to 2048, default 512. The image is the largest whole-module square that fits, so the real width is usually slightly smaller and is reported back.'}, 'level': {'enum': ['L', 'M', 'Q', 'H'], 'type': 'string', 'description': "Error correction level: 'L', 'M' (default), 'Q' or 'H'. Higher levels survive more damage but make the symbol denser."}, 'format': {'enum': ['png', 'svg'], 'type': 'string', 'description': "Output format: 'png' (default) or 'svg'. SVG requires Flyn Pro."}, 'margin': {'type': 'integer', 'maximum': 32, 'minimum': 4, 'description': 'Quiet zone in modules. Minimum and default is 4, as required by ISO/IEC 18004; smaller values are raised to 4 because a short quiet zone is the most common cause of a printed code failing to scan.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'tag': {'type': 'string', 'description': 'Optional: only return links carrying this tag.'}, 'page': {'type': 'integer', 'default': 1, 'minimum': 1, 'description': 'Page number, starting at 1.'}, 'sort': {'enum': ['created_at', 'clicks', 'slug', 'title'], 'type': 'string', 'default': 'created_at', 'description': 'Sort column.'}, 'limit': {'type': 'integer', 'default': 20, 'maximum': 100, 'minimum': 1, 'description': 'Results per page (max 100).'}, 'order': {'enum': ['asc', 'desc'], 'type': 'string', 'default': 'desc', 'description': 'Sort direction.'}, 'search': {'type': 'string', 'description': 'Optional text search across slug, destination URL, and title.'}, 'status': {'enum': ['active', 'expired', 'archived'], 'type': 'string', 'description': "Optional filter: 'active' (not expired, archived or disabled by Flyn), 'expired' (past its expiry date or set to expired, and not archived), or 'archived'."}}, 'additionalProperties': False}

{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'The link id to update.'}, 'url': {'type': 'string', 'description': 'New destination URL.'}, 'slug': {'type': 'string', 'description': 'New slug (changes the short URL; the old slug stops working).'}, 'tags': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Replacement tag list.'}, 'title': {'type': 'string', 'description': 'New title.'}, 'status': {'enum': ['active', 'archived'], 'type': 'string', 'description': 'Link status.'}, 'rotation': {'type': 'array', 'items': {'type': 'object', 'required': ['url', 'weight'], 'properties': {'id': {'type': 'string', 'description': "Stable identifier for this destination, recorded as the click variant on each click. Omit it on a brand new destination and Flyn mints one. When editing, send every existing destination back with the id it already has: click history is attributed by id, so a changed id detaches that destination's past clicks and a reused id merges two destinations' stats. Never derive ids from list position."}, 'url': {'type': 'string', 'description': 'Destination URL for this entry. Scanned with Google Safe Browsing like the primary destination.'}, 'label': {'type': 'string', 'description': 'Optional human-readable name for this destination. Cosmetic, it does not affect routing.'}, 'weight': {'type': 'number', 'minimum': 0, 'description': 'Relative share of traffic, NOT a percentage. Weights are normalised across the list, so [3, 1] sends roughly three quarters of clicks to the first entry and equal weights give an even split. A weight of 0 keeps the destination in the list without ever serving it.'}}, 'additionalProperties': False}, 'maxItems': 12, 'description': 'Replacement list of weighted rotation destinations (Pro plan only). This REPLACES the whole list, so read the link first and send back every destination you are keeping, each with the id it already has. Pass an empty array to stop rotating and serve the single url again. Up to 12 destinations; sending more is rejected rather than truncated, so nothing is dropped without telling you. Each human visitor is sent to one destination drawn at random in proportion to its weight, so the split settles over many clicks rather than following a strict order. Bots and crawlers always get the primary url, which stays required. Each click records the id of the destination that served it, and that id, not the url and not the list position, is what per-destination stats are keyed on. The Flyn dashboard does report them: the link\'s own analytics page has a "Destination Performance" panel listing every destination with its click count, its actual share of clicks, and the share its weight intended, and it keeps showing a destination you later remove from the rotation. No API or MCP call returns that breakdown, or the per-click destination id, so send the user to that page rather than inventing a tool call for it. The panel counts clicks only, across the clicks that carry a destination id: no conversion or revenue split, and no winner declared.'}, 'expiresAt': {'type': ['string', 'null'], 'description': 'New ISO 8601 expiration, or null to remove.'}, 'clickLimit': {'type': 'integer', 'minimum': 1, 'description': 'Maximum human clicks before the link stops (Pro plan only).'}, 'fallbackUrl': {'type': 'string', 'description': 'URL served after the click limit is reached (Pro plan only).'}, 'forwardParams': {'type': 'boolean', 'description': 'Forward appended query params to the destination.'}, 'conversionTracking': {'type': 'boolean', 'description': 'Enable or disable per-link conversion tracking (Pro plan only). Enabling only makes the redirect append a click id; conversions arrive from the Flyn tag or the server postback on the destination site.'}}, 'additionalProperties': False}