templates

Get a template

One template by project id or listing slug, with its render_request, so it can be inspected before it is used. No API key needed for a published template.

get/v1/templates/{id_or_slug}

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/templates/{id_or_slug}
  • Auth: HTTP bearer

Path parameters

id_or_slugstring required

Response

Successful Response

idstring required

The template's project id.

scope'public' | 'workspace' required

public (in the gallery, from a listing) or workspace (one of your templates).

namestring required

The listing title for a public template, else the project name.

descriptionstring nullable

Listing copy. Null for workspace templates.

categorystring nullable

Listing category. Null for workspace templates.

tagsstring[]
widthinteger required

Canvas width in pixels.

heightinteger required

Canvas height in pixels.

aspect'landscape' | 'portrait' | 'square' required

From width and height.

durationnumber required

Composition length in seconds.

element_countinteger required
thumbnail_urlstring nullable

Poster image; null until one is generated.

versioninteger required

The head version the card describes.

thumbnail_versioninteger nullable

The head version the thumbnail shows; stale while below version.

preview_urlstring nullable

A finished render to play on hover. Public templates only for now.

premiumboolean
listing_idstring nullable

The gallery listing, for public templates.

slugstring nullable

The listing's stable handle: GET /v1/templates/{slug}.

priorityinteger nullable

Listing order, highest first.

status'draft' | 'published' nullable

Listing status. draft reaches admin workspaces only.

familystring nullable

Links the size variants of one design.

created_atstring date-time required
updated_atstring date-time required

Changes

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