make_qr_code
Make a QR code
Make a static QR code for a link, text, Wi-Fi network, contact card, email, phone number or SMS, free and with no account. Returns a PNG and an SVG download link that the user can open, save or print; show the PNG link to the user. Static codes hold the content in the pattern, so they never expire and keep working without Snip. Use this whenever the user asks for a QR code.
Parametersbgfgeccdatarequiredstyle
shorten_link
Shorten a link
Turn a long web address into a short snip.link link, free, and get a QR code for it. Use this when the user wants a short link, a link they can change after printing, or click and scan counts. When the user is not signed in to Snip the link works at once and the answer includes a claim link the user can open to keep it in a free Snip account and see its clicks. When they are signed in (the account endpoint or an API key) the link is saved to their account, and a custom ending (snip.link/your-ending) is allowed.
Parametersurlrequiredtitledomainendingroutes
save_page
Save and read a web page
Read any web page as clean Markdown and keep a copy that stays the same even if the page changes or disappears. Returns the page's text in the answer, plus a short snip.link link and QR code for it, and the saved copy as Markdown, plain text, a full-page screenshot, a PDF and a web archive (each at the short link with an ending: .md, .txt, .jpg, .pdf, .mhtml). Free, no account needed. Use this when the user wants to read, quote, cite, summarize, archive or share a web page, or asks for a page as Markdown, text, a screenshot or a PDF. A page anyone saved in the last hour comes back at once.
Parametersurlrequiredfreshformats
drop_file
Share a file with a short link
Put a file on the web and get a short snip.link link to it, free. Send text (a note, Markdown, CSV, JSON, code) as `content`, or any other file (a PDF, a picture, a document) as `content_base64`, with its file name. The link opens a page that shows the file with a download button and a QR code; the link with the file's extension is the file itself, and other endings convert it (.pdf, .png, .md, .txt, .html, .csv, .json). Use this when the user wants to share, send, publish, host or link to a file, or wants something you wrote available as a link or a QR code. Files shared without an account stay up for 30 days unless the user keeps them with a free account.
Parametersnamerequiredtitlecontentcontent_base64
get_link_stats
Get link stats
Clicks and QR scans for one of the user's own Snip links: totals, by day, by hour of the day on plans with time-of-day analytics, and the top countries, referring sites and devices. Needs the user signed in to Snip (the account endpoint or an API key). Pass the short link, its ending or its id. For every link at once, use get_account_stats.
Parametersdayslinkrequired
get_account_stats
Get account stats
Clicks and QR scans across every link in the user's Snip account: totals, by day, the busiest links, and the top countries, referring sites and devices. Needs the user signed in to Snip. Use this for questions like "how are my links doing" or "which link got the most scans this week".
Parametersdayslinks
The user's Snip links, newest first, with their destinations and click counts. Needs the user signed in to Snip. Pass a search to match an ending, a destination or a title.
Parameterslimitsearch
Changes the ending, destination, title, rules, schedule (go-live time, expiry, click limit) or link preview (the title, line and picture chat apps and social sites show when the link is pasted) of one of the user's Snip links, switches it off and on, or watches its page for changes. Custom endings and renaming are free with an account. Previous short URLs and printed QR codes keep working, follow the latest destination and share the same analytics until the link is disabled or deleted. A link keeps up to 20 previous endings. Needs the user signed in to Snip. Pass only the fields to change.
Parametersurllinkrequiredtitletrackwatchendingroutespreviewdisabledstarts_atexpires_atmax_clicks
Permanently deletes one of the user's Snip links and its click history; its current and previous short URLs stop working within a minute and all of its endings are free again. Needs the user signed in to Snip. Confirm with the user first; to pause every ending instead, use update_link with disabled true.
Parameterslinkrequired
list_domains
List own domains
The user's own domains (go.yourbrand.com) that their Snip links can use, with whether each is live. Pass a live one as domain to shorten_link. Needs the user signed in to Snip; adding a domain happens in the dashboard (it needs a DNS record).
Takes no parameters.
list_collections
List collections
The user's Snip collections: links grouped by hand, each with how many links it holds and its public page (snip.link/c/<address>, one button per live link) when that is on. Needs the user signed in to Snip. Change one with save_collection.
Takes no parameters.
save_collection
Create or change a collection
Creates a collection of the user's Snip links, or changes one (pass collection, its id from list_collections): its name, the line under it, its links in order, and whether it has a public page at snip.link/c/<address> that shows one button per live link, link-in-bio style. links replaces the collection's links in that order; leave it out to keep them. Free on every plan; the links themselves never change. Needs the user signed in to Snip.
Parametersnamesluglinkspubliccollectiondescription