List templates

GET

/v1/templates

const url = 'https://proficient-seahorse-829.eu-west-1.convex.site/v1/templates?project_id=proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Lists the templates a project exposes, in the order the project defines them.

Authorizations

apiKey

Parameters

Query Parameters

project_id

required

Project ID

string

>= 1 characters

Example

proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9

Project ID

Responses

200

The project’s templates

application/json

object

data

required

Array<object>

object

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

Example

{
  "data": [
    {
      "id": "tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f",
      "name": "Welcome video",
      "description": "One clip per new customer.",
      "project_id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
      "target_composition_id": "comp_4f1f0f7c",
      "field_count": 3
    }
  ]
}

404

Project not found

application/json

object

error

required

string

Example

{
  "error": "Render not found"
}