Skip to main content
GET
/
jobs
/
{id}
Get job details
curl --request GET \
  --url https://api.nexrender.com/api/v2/jobs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

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.

​
Job Status Lifecycle

StatusDescription
queuedWaiting to be picked up by a render worker
pendingParent job waiting for child jobs to finish (nested jobs only)
render:dorenderActively rendering
finishedRender complete - outputUrl is available
errorRender failed - see the error field for details
manually_cancelledJob was cancelled via the API

​
Poll a Single Job

Fetch the current state of a job at any time with GET /jobs/:id. 
curl -X GET https://api.nexrender.com/api/v2/jobs/01JTRDF7HCR8QAHYW8GPCP4S9Y \
  -H "Authorization: Bearer YOUR_API_KEY"

​
List Jobs

Use GET /jobs to fetch multiple jobs at once, with optional filters for status, date range, and sort order. 
curl -X GET "https://api.nexrender.com/api/v2/jobs?states=queued,render:dorender&limit=50&sort=oldest_first" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Query Parameters

ParameterTypeDescription
statesstringComma-separated list of statuses to include (e.g. queued,finished)
exclude_statesstringComma-separated list of statuses to exclude
fromintegerPagination offset (0-indexed)
limitintegerMax jobs to return (1-1000)
from_datestringFilter jobs created after this ISO 8601 date
to_datestringFilter jobs created before this ISO 8601 date
sortstringoldest_first (default), newest_first, random, or priority
tagsstringComma-separated tags to filter by
minimalbooleanReturn stripped-down job objects (excludes stats and assets) for faster responses
Rather than polling, configure a webhook on the job to receive a notification the moment rendering completes or fails. 
{
  "template": { "id": "YOUR_TEMPLATE_ID", "composition": "main" },
  "webhook": {
    "url": "https://yourdomain.com/webhooks/render-complete"
  }
}
Nexrender will POST the full job payload to your endpoint when the job reaches a terminal state. 
{
  "id": "01JTRDF7HCR8QAHYW8GPCP4S9Y",
  "status": "finished",
  "outputUrl": "https://nx1-outputs-eu.nexrender.com/.../job.mp4",
  "stats": {
    "finishedAt": "2025-08-14T08:01:10.304Z",
    "renderDuration": 22.304
  }
}
Your webhook endpoint must return a 2xx response. Make it idempotent - Nexrender retries failed deliveries up to 3 times with exponential backoff.

​
Webhook Retry Logic

If your server is unavailable or returns a non-2xx response, Nexrender retries delivery up to 3 times with exponential backoff. To maximise reliability:
  • Respond with 200 OK immediately and process the payload asynchronously
  • Keep response time under 2 seconds to avoid timeout-triggered retries
  • Log all incoming webhook payloads for auditability

​
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 job identifier

Response

Successfully retrieved job details

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.). Manually cancelled jobs are normalized to manually_cancelled in v2 responses even though they are stored internally as error.

​
progress
number<float>

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