Get a template

GET

/v1/templates/{template_id}

curl --request GET \
  --url 'https://proficient-seahorse-829.eu-west-1.convex.site/v1/templates/tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f?project_id=proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9' \
  --header 'Authorization: Bearer <token>'

• Production

Retrieves one template, including every field it exposes - the keys a render’s values object can set.

Authorizations

• apiKey

Parameters

Path Parameters

template_id

required

Template ID

string

>= 1 characters

Example

tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f

Template ID

Query Parameters

project_id

required

Project ID

string

>= 1 characters

Example

proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9

Project ID

Responses

200

The template

Media typeapplication/json

object

id

required

string

name

required

string

description

required

string | null

project_id

required

string

target_composition_id

required

The composition this template renders.

string

field_count

required

number

fields

required

Array<object>

object

key

required

The key to use in a render’s values object.

string

label

required

string | null

description

required

string | null

kind

required

What the field drives.

string

widget

required

How the editor renders the input.

string | null

default_value

required

Any of:

string

string

number

number

boolean

boolean

null

null

Example

{
  "id": "tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f",
  "name": "Welcome video",
  "description": "One clip per new customer.",
  "project_id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
  "target_composition_id": "comp_4f1f0f7c",
  "field_count": 3,
  "fields": [
    {
      "key": "customer_name",
      "label": "Customer name",
      "description": "Shown on the opening card.",
      "kind": "control",
      "widget": "text",
      "default_value": "Acme"
    }
  ]
}

404

Template not found

Media typeapplication/json

object

error

required

string

Example

{
  "error": "Render not found"
}