Skip to main content
GET
Get template metadata (v3)
Once a template is uploaded, you can inspect it to discover its available compositions and layers before submitting jobs. You can also update its display name and download the original source file.
The v2 inspection API (GET /api/v2/templates/{id} returning embedded compositions and layers arrays) is deprecated and will be removed in a future release. Use the v3 endpoints below for all new integrations.

Fetch a Template (v3)

The v3 API splits introspection into three separate endpoints. The main metadata endpoint returns a lightweight object - compositions and layers are fetched separately.

1. Get template metadata

2. List compositions

GET /v3/templates/{id}/compositions returns paginated compositions with full AE metadata.
The name field is the value to use as template.composition when submitting a render job.

3. List layers

GET /v3/templates/{id}/layers returns paginated layers with full structural metadata.

Pagination

Both /compositions and /layers support limit and offset query parameters (default limit is 300, max 1000). Use these for templates with large numbers of layers:

Template Status Values

List All Templates

Update Display Name

Use PATCH /templates/{id} to rename a template. Only displayName can be updated.

Download the Source File

GET /templates/{id}/download returns a presigned URL for downloading the original template file from storage.
The URL is temporary - use it promptly. If you need to re-download, request a fresh URL via the same endpoint.

Template Storage and Retention

Templates are persisted indefinitely unless deleted manually. Regularly delete old or unused templates to keep your account tidy - use DELETE /templates/{id} or see the Deleting Templates page. For clean room setups, templates can be stored in secure customer-owned storage rather than on Nexrender’s side. In this case, template introspection (compositions, layers) and caching are not available - your job payloads must reference composition and layer names directly.

API Reference

Authorizations

Authorization
string
header
required

Bearer token authentication using API tokens for team-based access control.

You can generate your own API token at: https://app.nexrender.com/settings/api-tokens

Path Parameters

id
string
required

Unique template identifier in ULID format

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Successfully retrieved template metadata

Lightweight template metadata returned by the v3 template API. Composition and layer structure is exposed through separate paginated endpoints.

id
string
required

Unique template identifier used for referencing in jobs and API operations

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
type
enum<string>
required

Template file format

Available options:
aep,
zip,
mogrt
displayName
string
required

Human-readable template name

status
enum<string>
required

Current template processing status

Available options:
awaiting_upload,
downloading,
processing,
uploaded,
error
createdAt
string<date-time>
required

ISO timestamp when the template was created

updatedAt
string<date-time>
required

ISO timestamp when the template was last updated