Templates

List active cover templates

Lists the active cover templates, sorted by name, optionally filtered by genre and subgenre. The list comes from the same template catalog that POST /api/v1/covers/generate checks templateId against, so every listed id can be pinned. Each template carries its previewImage URL and its variants. With subgenre, the list is the pool that subgenre renders from, and each template also carries subgenreMatch (always true). subgenre requires genre.

get/api/v1/templates

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/templates
  • Auth: HTTP bearer

Query parameters

genrestring

Genre slug (e.g. science-fiction) or canonical value (e.g. Science Fiction). When given without subgenre, returns the union of the templates serving any subgenre under the genre's bucket and the pools its subgenres route to (a Young Adult subgenre routes to a fiction pool).

subgenrestring

Subgenre value; must be valid for the given genre. Requires genre. Returns only the templates of the pool that subgenre renders from.

Response

Template list.

totalinteger required

Changes

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