Skip to main content
POST
/
jobs
Create new job
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": {
    "type": "video",
    "frames": 1,
    "quality": "draft",
    "codec": "<string>"
  },
  "upload": {
    "prefix": "<string>",
    "outputUrl": "<string>",
    "provider": "s3",
    "params": {
      "endpoint": "https://s3.amazonaws.com",
      "region": "<string>",
      "bucket": "<string>",
      "acl": "<string>",
      "accessKeyId": "<string>",
      "accessKeySecret": "<string>"
    }
  },
  "webhook": {
    "url": "<string>",
    "method": "POST",
    "headers": {},
    "data": {},
    "custom": false
  }
}'
{
  "id": "<string>",
  "templateId": "<string>",
  "status": "<string>",
  "progress": 123,
  "stats": {
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "errorAt": "2023-11-07T05:31:56Z",
    "totalAssets": 123,
    "renderDuration": 123,
    "error": "<string>"
  },
  "outputUrl": "<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/team/settings

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

​
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, ...) to use in the render

​
settings
object

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

​
upload
object

Custom upload configuration for output files to external storage providers

​
webhook
object

Webhook configuration for job status notifications and callbacks

Response

Job successfully created and queued for processing

Render job with current status, progress, and detailed statistics

​
id
string

Unique job identifier used for tracking and API operations

​
templateId
string | null

Reference to the template used for this job (null if template was not used)

​
status
string

Current job status (queued, render:dorender, finished, error, etc.)

​
progress
number

Render progress as a percentage (0.0 to 100.0)

​
stats
object

Detailed timing and metadata statistics for the job

​
outputUrl
string | null

URL to the rendered content

⌘I