list_taxonomy
Every valid style, category, pattern, platform, and viewport id, with the written cues behind each style. Filters are a controlled vocabulary, so an id that was guessed rather than read from here matches nothing.
Returns Text. No images, no licence needed.
search_designs
Find entries by free text, taxonomy filters, or both. Metadata only, so it is cheap to call broadly and the right way to build a shortlist before spending any image budget.
- querystring, optional
- Plain words, such as 'a dark terminal-style dev tool' or 'pricing with a comparison table'. Matched against name, description, keywords, styles, and captions, and common words are mapped onto the taxonomy for you.
- stylesstring[], optional
- Style ids. OR-ed.
- categoriesstring[], optional
- Category ids. OR-ed.
- patternsstring[], optional
- Pattern ids. Narrows results to screenshots showing that screen type.
- platformsstring[], optional
- Platform ids. OR-ed.
- limit1 to 50, default 10
- How many entries come back.
Returns Text: matching entries with their screenshot ids. No images, no licence needed.
get_screenshots
The images themselves, for the handful of designs worth looking at. Six per call at most, because images are the expensive thing in a context window.
- idsstring[], required
- Screenshot ids from search_designs, in the form <slug>/<filename>.
- includePaidboolean, optional
- Omit it and you get licensed assets when the account is licensed, previews otherwise. false forces previews even with a licence. true still requires one.
Returns Images. Low-resolution folds are free. Crisp folds, full-page overviews, and segments need a licence, and licensed objects answer 402 without one.
get_reference_pack
A coherent reference from one site, page and theme, with overview, readable desktop, section detail and mobile roles. Missing evidence is reported explicitly.
- slugstring, required
- Site slug, URL, or name chosen from search results.
- pagestring, default /
- Exact captured page path.
- detailPatternstring, default feature-section
- Pattern for the section detail.
- includePaidboolean, optional
- Omit to use your entitlement. false selects previews; true still requires a licence.
Returns Up to four images with a role manifest, missing roles and capture warnings. Licensed originals require a licence.
get_site
The full record for one entry, including every screenshot id and caption. Accepts a slug, a URL, or a product name.
- slugstring, required
- Registry slug, URL, or name.
Returns Text. No images, no licence needed.
random_inspiration
A sampled set of entries for when the brief is open-ended and you want a starting point rather than an answer.
- stylesstring[], optional
- Constrain the sample to these styles.
- count1 to 10, default 3
- How many entries to sample.
- seedinteger, optional
- Reproduce a previous sample.
Returns Text. No images, no licence needed.