Hovercode

它列出的 36 个工具

“只读”和“会改数据”是服务方自己标的。带下划线的参数是必填的。

1. build_page

   Build a rich, on-brand landing page from an ordered list of typed blocks, publish it, and return its live URL + its own QR code (`qr_id`; style it with the QR design args here, restyle later with update_qr_code — don't create another). This is the 'make me a page for X' tool — e.g. an event, product, restaurant, link-in-bio, or a scan-to-enter sweepstakes. Each block is {type, content}; call list_block_types first to see every type and its content shape. Blocks render in order in a centered column; a 'header' block (name/bio/photo) is the profile.

   workspace primary_color background_color eye_style eye_color pattern frame frame_color text text_secondary has_border logo_url error_correction color_scope title description blocks publish bg_color text_color domain slug

2. create_folder

   Create a folder to organise QR codes, optionally nested under a parent. Creating a folder that already exists (same name, same parent) returns the existing one, so it's safe to call repeatedly.

   workspace name parent

3. create_form

   Create a form, define its fields, brand it, publish it, and return a shareable short link + QR in one step. Use for 'make me a form to collect X, give me a link and QR to share it'. The result's `share_url` is the public link and `qr_id` is the form's own dynamic QR code (image included) — never call create_qr_code or create_short_link for a form's link; pass QR design args (primary_color, eye_style, frame, logo_url, …) here to style that code in the same call. Supports on-brand styling (theme/colors/logo), a `redirect_url` after submit, conditional logic (`show_when` on a field) and branching endings (`outcomes`), and a custom domain/slug. Publishing mints a dynamic short link and QR — always dynamic, no static option, since a form has to resolve somewhere live. Notifications are a separate, paid, verified-member setting. To change a form later, use update_form.

   workspace primary_color background_color eye_style eye_color pattern frame frame_color text text_secondary has_border logo_url error_correction color_scope title description fields outcomes theme bg_color text_color button_color button_text_color redirect_url thank_you_message domain slug

4. create_page

   Create a published micro landing page (link-in-bio style) with a title and a list of links, and return its live URL (`share_url`) + its own QR code (`qr_id`; style it with the QR design args here; don't create another). Use this for 'make me a page with these links and a QR to share it'. The page is a dynamic destination you can keep; it counts toward the workspace's page limit.

   workspace primary_color background_color eye_style eye_color pattern frame frame_color text text_secondary has_border logo_url error_correction color_scope title description links bg_color text_color domain slug

5. create_pdf_qr

   Create a dynamic QR code and short link for a PDF (menus, flyers, tickets). Host the PDF by passing `pdf_url` (a link Hovercode fetches) or `pdf_base64` (the file's base64 bytes). Returns a shareable short link plus a rendered QR. Because it's dynamic you can later swap the PDF without reprinting the code — always dynamic, no static option here. Counts toward the same workspace dynamic-code limit as create_qr_code (list_workspaces' `dynamic_qr_limit`); past that limit this call returns an error.

   workspace pdf_url pdf_base64 filename display_name domain tags

6. create_qr_code

   Create a Hovercode QR code and return its details plus a rendered PNG. `dynamic: true` makes the destination changeable later and tracks scans; `dynamic: false` (the default, 'static') encodes the destination directly into the code image — it can never be retargeted or tracked, and this choice can't be changed after creation. If the request doesn't make the choice clear, ask the user whether it should be trackable and editable later, or fixed permanently once printed. Dynamic codes count toward the workspace's dynamic-code limit (list_workspaces' `dynamic_qr_used`/`dynamic_qr_limit`); past that limit this call returns an error. Supports full design control (colors, pattern, eye style, frames with captions, logo). Not for Hovercode forms, pages, or short links: those already have their own QR code (returned as `qr_id` / `id`) — use download_qr or update_qr_code with that id instead.

   workspace qr_data qr_type vcard dynamic display_name template folder gps_tracking tags primary_color color_scope background_color eye_style eye_color pattern frame frame_color text text_secondary has_border logo_url error_correction

7. create_qr_codes_bulk

   Create many QR codes at once from a list — e.g. 'make codes for these 20 product URLs in our brand colors'. All codes share the design/options you pass (colors, pattern, frame, dynamic, template). Returns the created codes and any per-item errors. Max 100 per call.

   workspace items dynamic template idempotency_key tags primary_color color_scope background_color eye_style eye_color pattern frame frame_color text text_secondary has_border logo_url error_correction

8. create_short_link

   Create a tracked short link for a URL. It comes with its own QR code (same id; use download_qr). Supports a custom slug and a custom domain. The destination can be changed later with update_short_link, and clicks are tracked. Never shorten a link that is already a Hovercode short link, form link, or page link — those are already tracked and already have a QR code.

   workspace link display_name slug domain gps tags

9. delete_folder会改数据

   Delete a folder. The codes in it (and in its subfolders) are NOT deleted — they become unfiled — and its subfolders move up to its parent.

   id

10. delete_page会改数据

    Delete a landing page. Its live URL stops serving and it leaves the workspace's page list. Use for 'delete that page' / 'remove the landing page'.

    id

11. delete_qr_code会改数据

    Delete a QR code. Dynamic codes stop redirecting after deletion.

    id

12. delete_short_link会改数据

    Delete a short link. It stops redirecting after deletion.

    id

13. download_qr只读

    Get downloadable, print-ready image links for a QR code — a high-resolution PNG and a vector SVG (best for print/large sizes). Returns URLs you can share or save.

    id

14. get_analytics只读

    Scan analytics over a period: totals, unique scanners, scans-by-day, and top countries/cities/OS/browsers. Pass a QR code `id` for one code, or omit it for the whole workspace (which also returns the top codes). Use this to answer 'how did my codes do this month and where were people scanning?'.

    workspace id days start end

15. get_form只读

    Get one form's details: status, response count, share link, and QR.

    id

16. get_form_responses只读

    List a form's submissions (newest first) so you can read or summarize them — e.g. 'summarize this week's feedback' or 'any complaints in the responses?'. Email and phone answers are hidden unless `include_contact_details` is set.

    id page page_size include_contact_details

17. get_page只读

    Get one landing page's details: status, live URL, QR, and its blocks (each block's id + type) so you can edit it with update_page.

    id

18. get_qr_activity只读

    List recent scan events for a dynamic QR code (time, location, device). Use this to answer questions like where or when a code was scanned.

    id page page_size start end

19. get_qr_code只读

    Get one QR code's details and scan analytics (total and unique scans), plus a rendered PNG.

    id

20. get_short_link只读

    Get one short link's details, destination, click counts, and QR.

    id

21. get_short_link_activity只读

    List recent click events for a short link (time, location, device).

    id page page_size start end

22. list_block_types只读

    List the page BLOCK TYPES available to build_page, each with its content JSON Schema. Call this first when composing a rich page so you know the vocabulary (header, link, text, image, button, video, gallery, faq, countdown, socials, divider, form, …).

23. list_folders只读

    List the workspace's folders with their full path, code count, id and slug. Use a folder's id or slug with create_qr_code / update_qr_code (`folder`) to file codes, or with list_qr_codes to filter.

    workspace

24. list_forms只读

    List the forms in a workspace, newest first. Optional `query` searches by title.

    workspace query page page_size

25. list_pages只读

    List the landing pages in a workspace, newest first.

    workspace

26. list_qr_codes只读

    List QR codes in a workspace, newest first. Optional `query` searches destination, name, and tags. `folder` narrows to one folder, `include_tags` adds each code's tags (its folder is always shown), and `include_scans` adds scan counts — use it instead of calling get_analytics once per code.

    workspace query folder subfolders include_scans include_tags page page_size

27. list_short_links只读

    List short links in a workspace, newest first. Optional `query` searches URL, name, and slug.

    workspace query page page_size

28. list_tags只读

    List the workspace's tags (title + id). Tags are attached with create_qr_code (`tags`) or update_qr_code (`add_tags` / `remove_tags`), and list_qr_codes searches by tag.

    workspace

29. list_templates只读

    List the workspace's saved QR design templates. Pass a template id to create_qr_code to reuse its branding.

    workspace

30. list_workspaces只读

    List the workspaces this account can access, with their ids; the current (default) one is marked. Tools default to the current workspace, so you only need `workspace` to target a different one.

31. set_workspace

    Switch the current (default) workspace by id or name. New codes, forms, and pages are created in the current workspace unless a tool is given an explicit `workspace`.

    workspace

32. update_folder会改数据

    Rename a folder and/or move it under another folder. `parent` 'none' moves it to the top level. Codes inside keep their filing.

    id name parent

33. update_form会改数据

    Change an existing form without recreating it: edit its fields, settings (redirect, thank-you, title), or branding (theme/colors/logo), or close/reopen it. If you pass `fields`, provide the COMPLETE desired list — include each existing field's `id` (from get_form) to keep it; omit a field to remove it; leave `id` off a new field. If the form is already published, edits are re-published so they go live.

    id status title description fields outcomes theme bg_color text_color button_color button_text_color logo_url redirect_url thank_you_message

34. update_page会改数据

    Change an existing landing page without recreating it: edit its blocks, title, description, or colors, and publish/unpublish it. Use for 'fix the typo on my page', 'add a section', or 'take the page down'. If you pass `blocks`, provide the COMPLETE desired list (same {type, content} shape as build_page; include each block's `id` from get_page to keep it, omit to remove) — leaving `blocks` off keeps the existing blocks untouched. If the page is already published, edits are re-published so they go live; pass publish:false to take it offline.

    id title description blocks bg_color text_color publish

35. update_qr_code会改数据

    Update a QR code in place — the same code keeps working, so it's safe for already-printed codes. Changing `qr_data` retargets a DYNAMIC code's destination. Design fields (colors, pattern, eye style, frame, logo) restyle the code WITHOUT replacing it. Also supports renaming, toggling location tracking, moving it into a folder (`folder`, or 'none' to unfile), and adding/removing tags. Returns the re-rendered QR so you can preview the result. Any combination works in one call. Only include a design field when you actually intend to change it: every one you pass is applied exactly as given, even a color identical to what you set at creation — there's no way to tell 'leave this as-is' from 'set this back to what it already was'. In particular, someone may have since edited the design directly (a widget's own Edit panel can change eye/frame color, pattern, or frame without that edit ever appearing in this conversation) — resending a color or style you remember from an earlier turn will silen

    id qr_data display_name gps_tracking folder add_tags remove_tags primary_color color_scope background_color eye_style eye_color pattern frame frame_color text text_secondary has_border logo_url error_correction logo_base64 logo_round remove_logo

36. update_short_link会改数据

    Update a short link. Changing `link` retargets it — the short URL keeps working, it just points somewhere new. Also supports renaming and toggling location tracking.

    id link display_name gps