Tools reference

The assistant picks these tools itself, so you don't need to name them. This page lists what each one does and what it changes.

Every tool that changes data is marked so that assistants ask you before running it. Assistants that support confirmation forms also show a DynaQR form listing the exact change, and nothing changes unless you accept it.

Results include a short text summary for the assistant and structured data (ids, short links, numbers) it can use in follow-up steps. Tools that show a code also return the QR image as SVG.

generate_static_qr

Draws a QR code that contains the text or URL itself. Nothing is saved, the code can't be edited and scans aren't counted. It doesn't use a dynamic code slot. It also checks the design and passes on warnings such as low contrast.

Your assistant makes dynamic codes unless you ask for a static one. If it can't tell which you want, it asks first. Every static result ends with a warning that the code can't be changed once printed, and on the Free plan it also suggests a dynamic code. The same tool is available with no account on the free endpoint.

Returns the image, the QR version (size), and any scannability warnings.

get_workspace

Returns the connected workspace's plan and how many dynamic code slots are used and available. No inputs.

list_codes

Lists dynamic codes, newest first, 100 per page, with id, status, destination, short link and tags. Archived codes are hidden unless you ask for archived ones.

get_code

Shows one code: destination, status, short link, tags, created and updated dates, its redirect rules, and the QR image.

create_dynamic_code

Creates a dynamic code that redirects to a URL and counts scans. Uses one dynamic code slot (Starter 25, Pro 100, Business 500). Returns the QR image, short link and id.

update_destination

Changes the destination of a URL code. Printed codes open the new destination. The result includes the previous URL, so you can ask the assistant to undo it.

pause_code

Pauses a code (scans see a "temporarily unavailable" page) or resumes it.

get_scan_stats

Scans, unique visitors and bot scans excluded, plus the top countries, cities, devices, operating systems, sources and matched rules for one code. Limited to the plan's history: one year on Starter, unlimited on Pro and Business.

set_redirect_rules

Replaces all redirect rules on a code. The assistant reads the current rules with get_code first and sends the full edited list; an empty list removes every rule. Conditions: country, region, city, device, language, time of day, days of the week and date range. Actions: redirect to a URL, or split traffic between 2 and 10 URLs for an A/B test. See Redirect rules in the API for the exact format.

list_leads

Lists lead form submissions, newest first, 100 per page, with name, email, phone, message, the code and form they came from, and the country. Leads are personal data, so the assistant is told to show them only to you.

export_leads

Same inputs as list_leads. Returns the page as CSV with the columns received, first_name, last_name, email, phone, message, code, form. Values that a spreadsheet would treat as formulas are made safe.

list_bio_pages

Lists bio pages with id, title, theme and number of links, and the plan's page limit. No inputs.

create_bio_page

Creates a mobile link page. Counts toward the plan's bio page limit (Starter 3, Pro 10, Business unlimited). The page goes live when a code points at it, which you set in the dashboard.

update_bio_page

Edits a bio page. Only the fields sent change. links replaces all link buttons; text, images, video, social links and lead forms added in the dashboard stay as they are. Changes go live on every code that shows the page.