Create new job

Submit a new render job with template, assets, and configuration options. Assets can include nested job definitions (type: ‘job’) that render as child jobs first, with their output automatically injected as video/image assets into the parent composition. Function assets support params.layerName as a string, and selected NX layer functions also support params.layerName as an array of strings expanded in order. When nested jobs are present, the parent job enters ‘pending’ state until all children complete.

POST /jobs

Create new job

cURL

curl --request POST \
  --url https://api.nexrender.com/api/v2/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": {
    "id": "<string>",
    "src": "<string>",
    "composition": "<string>"
  },
  "preview": false,
  "fonts": [],
  "assets": [],
  "settings": {
    "frames": 1,
    "codec": "<string>",
    "engine": "ae2026",
    "multiFrame": true,
    "lottie": {}
  },
  "upload": {
    "prefix": "<string>",
    "outputUrl": "<string>",
    "provider": "s3"
  }
}
'

201

{
  "id": "<string>",
  "status": "queued",
  "outputUrl": "<string>",
  "children": [
    {
      "id": "<string>",
      "outputUrl": "<string>",
      "status": "<string>",
      "missingFonts": [
        "<string>"
      ]
    }
  ],
  "missingFonts": [
    "<string>"
  ]
}

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 object for creating a new render job with template, assets, and options

template · object · required

Template configuration defining the After Effects project and composition to render

Show child attributes

preview · boolean · default: false

Generate a low-quality preview render instead of full quality output

fonts · string[]

List of font file names to include in the render environment

assets · object[]

Collection of media assets (images, videos, audio, scripts, text) or nested job assets (type: 'job') to use in the render. Nested job assets render as child jobs first, with output injected into the parent composition. For supported NX layer functions, params.layerName can be a string or an array of strings; array values are expanded in place while preserving asset order.

Asset to be used in job rendering, containing source information and target layer details. For function assets, provide the function identifier in name and arguments in params.

Option 1

Option 2

Show child attributes

settings · object

Render configuration settings for output format, quality, and frame selection

Show child attributes

upload · object

Custom upload configuration for output files to external storage providers

Show child attributes

webhook · object

Webhook configuration for job status notifications and callbacks

Show child attributes

Response

201

application/json

Job successfully created and queued for processing. Returns 'pending' status with children array when nested job assets are present.

Response after creating a job, includes children info for parent jobs

id · string · required

Unique job identifier

status · enum<string> · required

'queued' for regular jobs, 'pending' for parent jobs waiting on children

Available options: queued, pending

outputUrl · string · required

URL where the rendered output will be available

children · object[]

Child job details (only present for parent jobs with nested job assets)

Show child attributes

missingFonts · string[]

List of fonts referenced in template but not found in team's font library