Templated

Get the connected Templated account's render usage for the current period: renders used (apiUsage), renders included (apiQuota) and the percentage used. Use this to check how many renders are left before a large batch.

get_account

Get one template's details by ID: name, size, background, thumbnail, tags, folder, and layer and page counts. Use this to check a template's size or settings; get_template_layers returns its editable layers.

get_template

List a template's layers with their names, types and current values (text, image_url, colors, fonts, position and size). Use this before create_render: the layer names are the keys create_render accepts in 'layers'. Covers every page of a multi-page template; get_template_pages groups the layers by page.

get_template_layers

List the pages of a multi-page or multi-size template, each with its name, width, height and layers keyed by layer name. Use this to render specific pages with create_render ('pages') or to edit pages with update_template, which accepts the same shape.

get_template_pages

List the folders in the connected Templated account with the number of templates in each, 25 per page by default (max 100). Use this to find a folder ID for update_folder or delete_folder. Returns the folders plus total and hasMore.

list_folders

List the custom fonts uploaded to the connected Templated account, 25 per page by default (max 100). Templates can also use any Google Font by family name: set include_google_fonts to true to list those too, and query to search by name. Use this to choose a font_family for create_template or update_template, or to find the name for delete_font. Returns the font names plus total and hasMore.

list_fonts

List the renders in the connected Templated account, newest first, 25 per page by default (max 100). Use this to find a render's ID or file URL, for example to merge PDFs with merge_renders. Returns each render's id, url, status, format, size and template.

list_renders

List the renders created from one template, 25 per page by default (max 100). Use this to find earlier outputs of a template. Returns each render's id, url, status and format.

list_template_renders

List the templates in the connected Templated account, 25 per page by default (max 100), optionally filtered by name (query), size (width, height) or tags. Use this first to find the template ID for create_render, get_template_layers or update_template. Returns each template's id, name, size, thumbnail, folder, and layer and page counts.

list_templates

List the images uploaded to the connected Templated account, 25 per page by default (max 100). Use this to reuse an uploaded image: its 'path' is a URL that can be set as image_url on an image layer. Returns each upload's id, name, type, size and path.

list_uploads

Merge several renders into one PDF, in the order given, for example one certificate or invoice per recipient. Image renders become PDF pages. Use this after creating the individual renders. Each merge counts toward the account's render usage. Returns the URL of the merged PDF. With host set to false the PDF itself is returned inline instead, which only works for PDFs up to 100 KB.

merge_renders

Rename a folder. Use this when the user wants to change a folder's name. Returns the updated folder.

update_folder

Change an existing template: name, description, size, background, default video duration, layers or pages. Use this to edit a design, resize it, or add sizes to a multi-size template. Layers are matched by their 'layer' name: an existing layer is updated in place and a new name is added. Top-level 'layers' apply to the first page; 'pages' reaches the others. With replaceLayers true, layers missing from the request are deleted. To move a layer, send both x and y (a missing coordinate is set to 0). In 'pages', a page name that doesn't exist yet is added and an existing page has its layers updated. On a multi-size template, set width and height per page inside 'pages'; top-level width and height are rejected there because they would resize every page. Returns the updated template.

update_template

Upload a custom font file (TTF, OTF, WOFF or WOFF2) from a public URL to the connected Templated account under the given family name. Use this when a design needs a font that isn't a Google Font; templates then use it as font_family. Returns the font. API reference: https://templated.io/docs

upload_font

Upload an image (JPG, PNG, WebP or SVG, up to 10 MB) from a public URL to the connected Templated account. Use this to keep an image in the account's assets for templates and renders. Returns the upload; its 'path' is the URL to use as image_url. API reference: https://templated.io/docs

create_upload