Skip to main content
GET
/
templates
/
{id}
Get template details
curl --request GET \
  --url https://api.nexrender.com/api/v2/templates/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "type": "<string>",
  "displayName": "<string>",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "compositions": [
    "<string>"
  ],
  "layers": [
    "<string>"
  ],
  "mogrt": {},
  "error": "<string>",
  "uploadInfo": {
    "url": "<string>",
    "method": "PUT",
    "expiresIn": 123,
    "key": "<string>",
    "fields": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://nexrender.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
Fetch a Template

GET /templates/{id} returns the full template object including its processing status, compositions, and layers. 
curl -X GET https://api.nexrender.com/api/v2/templates/01JTGM9GCR71JV7EJYDF45QAFD \
  -H "Authorization: Bearer YOUR_API_KEY"
Use the compositions and layers fields to know exactly what to reference in your job payloads - no guessing at layer names.

​
Template Status Values

StatusMeaning
awaiting_uploadTemplate created but file not yet uploaded
uploadedFile received and introspected - ready for rendering
errorProcessing failed - see the error field for details

​
List All Templates

GET /templates returns all templates in your team account. 
curl -X GET https://api.nexrender.com/api/v2/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Update Display Name

Use PATCH /templates/{id} to rename a template. Only displayName can be updated. 
curl -X PATCH https://api.nexrender.com/api/v2/templates/01JTGM9GCR71JV7EJYDF45QAFD \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Product Promo v2"
  }'

​
Download the Source File

GET /templates/{id}/download returns a presigned URL for downloading the original template file from storage. 
curl -X GET https://api.nexrender.com/api/v2/templates/01JTGM9GCR71JV7EJYDF45QAFD/download \
  -H "Authorization: Bearer YOUR_API_KEY"
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

Response

Successfully retrieved template details

Complete template object with metadata, processing status, and content information

​
id
string

Unique template identifier used for referencing in jobs and API operations

​
type
string

Template file format (aep, zip, or mogrt)

​
displayName
string

Human-readable name displayed in UI and template listings

​
status
string

Current processing status (awaiting_upload, processing, uploaded, error)

​
createdAt
string<date-time>

ISO timestamp when the template was initially created

​
updatedAt
string<date-time>

ISO timestamp of the most recent template modification

​
compositions
string[]

List of compositions found within the template that can be rendered

Individual composition name available for rendering

​
layers
string[]

List of layers available for asset replacement and manipulation

Individual layer name within the template

​
mogrt
object

Motion Graphics Template specific metadata and properties

​
error
string | null

Error message if template processing or validation failed (null if successful)

​
uploadInfo
object

Presigned upload URL and metadata for securely uploading template files to cloud storage