Template Registration

Create new template

curl --request POST \
  --url https://api.nexrender.com/api/v2/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "src": "<string>"
}
'

import requests

url = "https://api.nexrender.com/api/v2/templates"

payload = {
    "displayName": "<string>",
    "src": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayName: '<string>', src: '<string>'})
};

fetch('https://api.nexrender.com/api/v2/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nexrender.com/api/v2/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'src' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nexrender.com/api/v2/templates"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"src\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nexrender.com/api/v2/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"src\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nexrender.com/api/v2/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"src\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": {}
  }
}

{
  "error": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

POST

templates

Create new template

curl --request POST \
  --url https://api.nexrender.com/api/v2/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "src": "<string>"
}
'

import requests

url = "https://api.nexrender.com/api/v2/templates"

payload = {
    "displayName": "<string>",
    "src": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayName: '<string>', src: '<string>'})
};

fetch('https://api.nexrender.com/api/v2/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nexrender.com/api/v2/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'src' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nexrender.com/api/v2/templates"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"src\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nexrender.com/api/v2/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"src\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nexrender.com/api/v2/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"src\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": {}
  }
}

{
  "error": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Before Nexrender Cloud can process your project files, you need to register a template object using the API.
This step defines what kind of project you’re uploading and prepares secure storage for it in Nexrender Cloud. You can register and upload one of the following file types:

.aep — Standard After Effects project
.zip — Bundled project with all assets included
.mogrt — Motion Graphics Template

Example: Register a Template

curl -X POST https://api.nexrender.com/api/v2/templates \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "aep",
    "displayName": "My First Video"
  }'

"template": {
        "id": "01K8NKEDR9HCGNK3BB7QM6XR8P",
        "type": "zip",
        "displayName": "test",
        "status": "awaiting_upload",
        "createdAt": "2025-10-28T14:27:10.217Z",
        "updatedAt": "2025-10-28T14:27:10.217Z",
        "mogrt": {}
    },
    "uploadInfo": {
        "url": "https://nx1-assets-eu.hel1.your-objectstorage.com/01JQEGHQFANYJT2Z52G7XV8JQQ/templates/01K8NKEDRBB7479ERKMERGXB7Z.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=LJ0F6FQU9N6ASUST5SQK%2F20251028%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20251028T142710Z&X-Amz-Expires=3600&X-Amz-Signature=38f4b903ee7f96d68368f8df4c1e7394a3a797716c9b8e838ef86625e39cb82d&X-Amz-SignedHeaders=host&x-amz-checksum-crc32=AAAAAA%3D%3D&x-amz-meta-templateid=01K8NKEDR9HCGNK3BB7QM6XR8P&x-amz-sdk-checksum-algorithm=CRC32&x-id=PutObject",
        "method": "PUT",
        "fields": {
            "Content-Type": "application/octet-stream",
            "x-amz-meta-custom": "{\"templateId\":\"01K8NKEDR9HCGNK3BB7QM6XR8P\"}"
        },
        "expiresIn": 3600,
        "key": "01JQEGHQFANYJT2Z52G7XV8JQQ/templates/01K8NKEDRBB7479ERKMERGXB7Z.zip"
    }
}

Uploading Your Files

Upload via Temporary Link

After registering a template, Nexrender Cloud generates a temporary upload link (uploadInfo.url).
This presigned URL allows you to securely upload your project file without additional authentication. The uploadInfo.url is a time-limited presigned URL — it grants secure, temporary access to upload the file directly. The method is always PUT.

Example `curl` Request

You can replace .zip with .aep or .mogrt depending on your project.

curl --location --request PUT \
  'https://your-upload-url-from-uploadInfo.url' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary '@/path/to/your/project.zip'

Limitations

To ensure stable upload performance, a few technical limitations apply:

Maximum file size: 2 GiB
Upload duration: URLs typically expire after ~1 hour
Upload method: Always PUT
File format: Must match the declared type (.aep, .zip, or .mogrt)

Files exceeding the 2 GiB limit or uploaded after expiration will fail with an HTTP 403 or similar error.

Refreshing an Expired Upload URL

If the presigned URL from template registration has expired before you completed the upload, request a fresh one using PUT /templates/{id}/upload. This generates a new presigned URL for the same template without creating a new template object.

curl -X PUT https://api.nexrender.com/api/v2/templates/01JTGM9GCR71JV7EJYDF45QAFD/upload \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "url": "https://nx1-assets-eu.cloudflarestorage.com/...?X-Amz-Expires=3600&...",
  "method": "PUT",
  "fields": {
    "Content-Type": "application/octet-stream"
  },
  "expiresIn": 3600,
  "key": "01JQEGHQFANYJT2Z52G7XV8JQQ/templates/01JTGM9GCR71JV7EJYDF45QAFD.zip"
}

Use the returned url exactly as you would the original uploadInfo.url - a standard PUT request with your file as the body.

Download Template Files During Template Registration

Instead of uploading template files manually, you can also provide a direct file URL during registration using the optional ‘src’ field. Nexrender will download the file automatically, process it, and transition the template through the same lifecycle.

 curl -X POST https://api.nexrender.com/api/v2/templates \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
   "type": "zip",
   "displayName": "Logo Animation",
   "src": "https://example.com/files/logo-animation.zip"
 }'

{
  "id": "tpl_01JZ2M9GCR712V7EJYDF45QAFD",
  "type": "zip",
  "displayName": "Logo Animation",
  "status": "downloading",
  "createdAt": "2025-10-28T09:57:43.121Z",
  "updatedAt": "2025-10-28T09:57:43.121Z",
  "mogrt": {},
  "error": null,
  "src": "https://example.com/files/logo-animation.zip"
}

What Happens Behind the Scenes?

The backend initiates a download of your file from the provided src URL
The system validates and processes the project automatically after download
Extracts available compositions and layers for later use in render jobs
The template status is initially set to downloading, then transitions to processing and finally uploaded.

If the platform cannot download the file, it will retry up to three times before setting the template status to error.

Requirements

The src must be a directly downloadable HTTPS link
Supported sources include:
- Secure https:// URLs
- Google Drive shared links
- Presigned S3 URLs
The maximum supported file size is 2 GiB
Maximum download time is 10 minutes

Common Mistakes to Avoid

Mistake	Result
Providing a non-secure `http://` link	The request will be rejected
Using an expired or inaccessible URL	Template enters the `error` state after retries
File larger than 2 GiB	Download will fail before processing

Once the download and processing are complete, the status will transition to uploaded, and Nexrender Cloud will extract all available compositions and dynamic layers for use in jobs.

Checking Upload Status

Once the upload is complete, the template status transitions automatically: awaiting_upload → processing → uploaded Once uploaded, Nexrender has completed introspection and the template is ready to render jobs. Use the v3 endpoints to inspect discovered compositions and layers - see Inspecting Templates.

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

Body

application/json

Configuration for creating a new template with project file type and display information

type

enum<string>

required

Template project file type - aep (After Effects Project), zip (compressed project), or mogrt (Motion Graphics Template)

Available options:

aep,

zip,

mogrt

displayName

string

required

Human-readable name for the template shown in UI and listings

Maximum string length: 255

src

string

Link to the project file nexrender should create the template from. If not set, presigned upload URL is returned in the response object instead.

Response

Template successfully created with upload information

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

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

Show child attributes

Essentials

Managing Templates

Rendering Jobs

Fonts Management

Example: Register a Template

Uploading Your Files

Upload via Temporary Link

Example `curl` Request

Limitations

Refreshing an Expired Upload URL

Download Template Files During Template Registration

What Happens Behind the Scenes?

Requirements

Common Mistakes to Avoid

Checking Upload Status

API Reference

Authorizations

Body

Response

​Example: Register a Template

​Uploading Your Files

​Upload via Temporary Link

​Example curl Request

​Limitations

​Refreshing an Expired Upload URL

​Download Template Files During Template Registration

​What Happens Behind the Scenes?

​Requirements

​Common Mistakes to Avoid

​Checking Upload Status

​API Reference

Authorizations

Body

Response

Example: Register a Template

Uploading Your Files

Upload via Temporary Link

Example `curl` Request

Limitations

Refreshing an Expired Upload URL

Download Template Files During Template Registration

What Happens Behind the Scenes?

Requirements

Common Mistakes to Avoid

Checking Upload Status

API Reference