cancel_batch
ChatGPTUse this only when the user asks to stop a bulk job. Stops further processing of a submitted or running job. Confirm first.
create_digital_business_card
ChatGPTUse this when the user wants a digital business card: a shareable mobile page with their name, role, company, phone, email, address and links, opened by QR code. Creates the card and its QR code in one step and returns both. The details are shown publicly on the card, so include only what the user wants shared. Pass idqrcode to turn an existing vCard QR code into a card. Do not use it for a plain contact QR code that stores the details in the code (use generate_qr_code with type VCARD).
create_digital_product_passport
ChatGPTUse this when the user wants a GS1 Digital Link QR code or a Digital Product Passport for a product: a QR code carrying the product's GTIN that opens a page with product details, traceability, certifications or links. Needs a GTIN and product details. Creates a dynamic code in the account. Do not use it for ordinary web-link QR codes.
create_launchpad_qrcode
ChatGPTUse this when the user wants a new landing page and a QR code that opens it in one step. Creates and publishes the page, a short link and a dynamic QR code, so confirm the title with the user first. Do not use it to edit an existing page.
create_short_link
ChatGPTUse this when the signed-in user wants a shorter, trackable web address for a link, with or without a QR code. Creates a QRStuff short link that redirects to the given URL and counts clicks. It is live and public immediately. Optional custom ending (slug); custom endings depend on the account. For a QR code of the short link, call generate_short_link_qrcode afterwards. Do not use it for a QR code that should open a URL directly (use generate_qr_code).
create_static_qr_code
ChatGPTUse this when the user wants a QR code image for a web link, plain text, Wi-Fi network, email, phone number, text message or contact card and does not need to edit, track or manage it afterwards. Returns a PNG or SVG image and a download link. No account is needed. The code cannot be changed after it is made and no scan counts are kept. Do not use it when the user wants to edit the destination later, see scan numbers, add a logo, or make a code for a file, menu, landing page, business card or product (use generate_qr_code).
create_support_ticket
ChatGPTCreate a Zendesk support ticket with the customer's name, email, and issue.
delete_link_page
ChatGPTUse this only when the user clearly asks to delete a landing page. Deletes it and marks its QR code deleted; the public page stops working. Confirm first.
delete_short_link
ChatGPTUse this only when the user clearly asks to delete a short link. Permanently deletes it and marks the QR code made from it as deleted, so the address stops working. Confirm with the user first.
generate_qr_code
ChatGPTGenerate a QR code via the QRStuff API.
generate_short_link_qrcode
ChatGPTUse this when the user wants a QR code for one of their short links. Creates the link's dynamic QR code, or updates it if it exists, and returns its ID; fetch the image with get_qr_code_by_id. Options: name, project, format, colours.
get_account_activity
ChatGPTFetch account activity: dynamic QR usage, monthly scan limits, scans this month. Uses GET /api/analytics/account-activity.
get_account_entitlements
ChatGPTUse this when the answer depends on what the user's account includes, for example "can I add a password to this code?". Returns the account's features and limits. Read-only. Use it to explain why something isn't available, never to promote a plan.
get_account_overview
ChatGPTFetch account-level analytics overview: project count, QR code count, total scans, users. Uses GET /api/analytics.
get_account_scans
ChatGPTFetch paginated scan data for the whole account. Uses POST /api/account/scans with optional group_by. Default date range: last 30 days.
get_batch_sample_file
ChatGPTUse this when the user wants to create many QR codes or short links from a spreadsheet and needs the template. Returns a download link to an XLSX template for the chosen types. Read-only.
get_batch_status
ChatGPTUse this when the user asks whether a bulk job has finished or how far it is. Read-only.
get_link_page
ChatGPTUse this when the user wants one landing page's status, editor link, preview link, short link and QR code. Read-only.
get_project_scans
ChatGPTFetch paginated scan logs for a project. Uses POST /api/projects/{idproject}/scans/ with pagination and date range. Returns one page at a time. Default date range: last 30 days to today.
get_qr_code_by_id
ChatGPTFetch full QR code details by id.
get_qrcode_history
ChatGPTFetch audit history for a QR code (created, updated, deleted, etc.). Uses GET /api/qrcodes/{idqrcode}/history with cursor pagination.
get_qrcode_scans
ChatGPTFetch paginated scan logs for a QR code. Uses POST /api/qrcodes/{idqrcode}/scans/ with pagination and date range. Returns one page at a time. Default date range: last 30 days to today.
get_scans_by_country
ChatGPTFetch scan counts grouped by country for account, project, or QR code. Uses POST scans endpoints with group_by=country. Default date range: last 30 days. For scope=qrcode only idqrcode is required.
get_scans_by_date
ChatGPTFetch scan counts grouped by date for account, project, or QR code. Uses POST scans endpoints with group_by=date. Default date range: last 30 days. For scope=qrcode only idqrcode is required.
get_scans_by_device
ChatGPTFetch scan counts grouped by device platform for account, project, or QR code. Uses POST scans endpoints with group_by=device. Default date range: last 30 days. For scope=qrcode only idqrcode is required.
get_scans_by_region
ChatGPTFetch scan counts grouped by region within a country for account, project, or QR code. Uses POST scans endpoints with group_by=region. Default date range: last 30 days. For scope=qrcode only idqrcode is required.
get_short_link
ChatGPTUse this when the user wants the full settings of one short link: destination, on or off, password, schedule, click limit. Needs the ID from list_short_links. Read-only.
get_short_link_clicks
ChatGPTUse this when the user asks how many times a short link was clicked, or where, when or on what device. Group by individual click, date, country, region or device, with an optional date range. For scans of a QR code use get_qrcode_scans. Read-only.
get_subscription_detail
ChatGPTFetch the current user's subscription detail via the QRStuff API. Returns id, status, billing period, term dates, items with name, quantity, unit_price, amount, period.
get_top_performing_date
ChatGPTFetch top-performing date analytics for account, project, or QR code.
get_top_performing_location
ChatGPTFetch top-performing location analytics for account, project, or QR code.
get_top_scanner
ChatGPTFetch top-scanner QR code analytics for account or project.
get_total_scans
ChatGPTFetch total scans analytics for account, project, or QR code.
get_trustpilot_review_url
ChatGPTReturn the Trustpilot review URL where customers can leave feedback.
get_unique_users
ChatGPTFetch unique users (unique scans) analytics for account, project, or QR code.
get_user_profile
ChatGPTFetch the current user's profile via the QRStuff API.
list_batches
ChatGPTUse this when the user asks what bulk jobs they have run, or you need a batch ID. Covers the last 30 days. Read-only.
list_deleted_projects
ChatGPTList deleted projects from the current user's account.
list_link_pages
ChatGPTUse this when the user wants to see or find their landing pages, or you need a page ID. Returns ID, title, status and the account's page limits. Read-only.
list_projects
ChatGPTList active projects with optional search, pagination, and sorting. Uses GET /api/projects. If `q` is provided, applies project-name search. Returns one page at a time.
list_qr_data_types
ChatGPTUse this when you need the exact fields for a QR code type before calling generate_qr_code (for example a coupon, PDF, event or GS1 passport), or the user asks what kinds of QR code can be made. Returns type names, labels, required data_fields, and whether a type needs a file upload or a dynamic code. Pass data_type for one type. Read-only.
list_qrcodes
ChatGPTList QR codes with optional project scope and name search. - If `idproject is provided, uses project QR codes endpoint. - If q` is provided, applies name search. - With neither, lists account QR codes.
list_short_links
ChatGPTUse this when the user wants to find their short links, or you need a short link's ID before changing it or checking clicks. Returns links with ID, destination and the account's short-link limits. Read-only.
move_qrcode_to_project
ChatGPTMove a QR code from one project to another under the user's account.
restore_deleted_project
ChatGPTRestore a deleted project to the current user's account.
restore_deleted_qrcode
ChatGPTRestore a deleted QR code to the current user's account. Either idqrcode or shorturl_key must be provided.
scan_business_card
ChatGPTUse this when the user shares a photo of a printed business card and wants the details pulled out, for example to build a digital business card. Reads name, phone, email, company and address from a JPEG or PNG and returns fields to pass to create_digital_business_card. Creates nothing. Not for QR codes (use scan_qr_code).
scan_qr_code
ChatGPTUse this when the user shares a picture of a QR code and wants to know what it contains or where it leads. Reads every QR code in a PNG, JPEG or WebP image and returns the decoded content and its type (link, Wi-Fi, contact, event, email, phone, payment, text). Read-only; creates nothing. Do not use it for counting how many times a code was scanned (use get_qrcode_scans) or for business cards (use scan_business_card).
search_knowledge_base
ChatGPTSearch the QRStuff knowledge base for relevant information against user query.
submit_batch
ChatGPTUse this when the user has filled in the bulk spreadsheet and wants the codes made. Starts a background job that creates one QR code or short link per row; check it with get_batch_status. Upload the XLSX with upload_file first (and a ZIP for file-based types).
transfer_qrcode
ChatGPTTransfer an anonymously created QR code to the current user's account. Either idqrcode or shorturl_key must be provided. Requires active paid subscription.
update_link_page
ChatGPTUse this when the user wants to rename a landing page or publish or unpublish it (status draft or published). Publishing makes it public. It does not edit page content; for that give the user the editor link from get_link_page.
update_qr_code
ChatGPTUpdate content and/or styling for an existing QR code. If content fields are not provided, only styling is updated. On success, returns updated details.
update_short_link
ChatGPTUse this when the user wants to change a short link: its destination, ending, on or off state, password, schedule, click limit or tracking options. Overwrites the previous settings, and changing the destination changes where the live link goes. Some options are rejected if the account doesn't include them. Needs the ID from list_short_links.
upload_file
ChatGPTUpload a file to QRStuff API and return its idfs_file.