latestOpenAPI 3.1.02026-08-101183295.3 KB

826e6edbf294

templates

Read one public image template or opt-in GIF template

The path remains the canonical slug for compatibility. Pass the stable id returned by search in the id query parameter for collision-free exact lookup. Pass mediaType=gif to read a GIF template with GIF metadata.

get/api/templates/{slug}

Path parameters

slugstring required

Canonical template slug.

Query parameters

idstring

Opaque, case-sensitive stable template id. It is never normalized as a slug; when present, exact id lookup takes precedence over the slug path.

mediaType'image' | 'gif' | 'all'

Response

Template details

idstring required

Opaque public identity used for deduplication and exact detail lookup.

sourceTemplateIdstring nullable required

Stored source identity, preserved without slug normalization.

variantOfstring nullable

slugstring required

Canonical URL and publishing slug. Use this field, not id, with legacy publishing APIs.

namestring required

descriptionstring required

mediaType'image' | 'gif'

Present for explicit mediaType requests; omitted by legacy default image routes.

imageUrlstring required

sourceUrlstring required

canonicalUrlstring required

detailUrlstring required

exampleImageUrlstring nullable

previewImageUrlstring

posterImageUrlstring

widthnumber nullable required

heightnumber nullable required

captionCountinteger required

boxCountinteger required

tagsstring[] required

categoriesstring[]

assetContentTypestring

animatedboolean

durationMsinteger nullable

frameCountinteger nullable

assetBytesinteger nullable

qualityStatus'approved' | 'quarantined' | 'rejected' | 'pending'