Product discovery

Search the public print catalogue

Searches every published print by free text and by any combination of attributes. Values within one attribute are OR-ed and attributes are AND-ed together, so colour=Blue&colour=Green&room=Bedroom means (blue or green) and bedroom. Each attribute accepts repeated parameters or a comma-separated list, and matches case-insensitively with dashes, underscores and spaces treated alike, so red-orange and Red Orange are the same value. Set facets=1 to receive the remaining attribute values with the count of prints each would yield, which is the reliable way to narrow a search without guessing at vocabulary. Use the returned id with the checkout and print-option endpoints.

get/api/prints

Request

  • Base URL: https://api.createprints.ai
  • URL: https://api.createprints.ai/api/prints
  • Auth: none required

Query parameters

qstring

Free text over title, keywords, colour and description. Terms match at the start of a word, so prefixes work and mid-word noise does not. Every term must match, so more words narrow the result.

colourstring

Colour category, e.g. Blue, Orange, Grey. color is accepted too.

roomstring

Recommended room, e.g. Bedroom, Living Room, Home Office.

traitstring

Mood, e.g. Serene, Bold, Grounded. mood is accepted too.

impactstring

Visual impact, e.g. Subtle, Moderate, Dramatic.

keywordstring

Subject or style keyword, e.g. botanical, minimal.

palettestring

Any named colour present in the artwork, from its extracted palette or its colour category, e.g. navy, sage, blue. Broader than colour, which is the single dominant category.

featured'1' | 'true'

Set to 1 to return only prints marked featured.

similarTostring uuid

A print id. Returns prints sharing any of its colour, room, mood, impact, keyword or palette, best match first, never the print itself. This is how to answer "more like this"; the attribute filters AND together and cannot express it. Composes with the other filters.

sort'relevance' | 'newest' | 'oldest' | 'featured' | 'similar'

Defaults to similar when similarTo is given, relevance when q is given, and newest otherwise.

limitinteger

Prints per response, 1-96.

offsetinteger

Rows to skip. Page with offset += limit while hasMore is true.

pageinteger

Shorthand for offset = (page - 1) * limit. Ignored when offset is given.

facets'1' | 'true'

Set to 1 to include the available attribute values and their counts.

Response

Matching prints, the total match count, and optionally the facet counts.

totalinteger required

Full match count, so a pager needs no second request.

limitinteger required
offsetinteger required
hasMoreboolean required
sort'relevance' | 'newest' | 'oldest' | 'featured' | 'similar' required
qstring nullable
appliedFiltersobject
truncatedboolean

Present only when the catalogue outgrew the search index and the answer is partial.

Changes

No recorded changes to this operation across all 1 revision of this API.