POST

Queue Render Job

Rendering

3 min read

Add a video to the render queue to generate the final MP4 file. The video must have completed media generation before it can be rendered.

POSThttps://api.videopilot.app/api/queue/render

This endpoint requires authentication. Include your API key in the Authorization header.

Parameters

The following parameters are supported for this endpoint:

Name	Type	Required	Default	Description
`video_id`	string	Required	-	ID of the video to render Example:`"video_123abc"`
`quality`	string enum	Optional	`"high"`	Render quality setting (low: 720p, medium: 1080p, high: 1080p with enhanced quality) Example:`"high"` Options:lowmediumhigh
`format`	string enum	Optional	`"mp4"`	Output format (currently only mp4 is supported) Example:`"mp4"` Options:mp4
`priority`	number	Optional	`5`	Queue priority (1-10, higher numbers = higher priority) Example:`7` Min: 1, Max: 10
`webhook_url`	string	Optional	-	URL to receive webhook notification when render completes Example:`"https://your-app.com/webhooks/render-complete"`

Code Examples

Example requests in multiple programming languages:

curl -X POST https://api.videopilot.app/api/queue/render \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "video_id": "video_123abc",
  "quality": "high",
  "format": "mp4",
  "priority": 7,
  "webhook_url": "https://your-app.com/webhooks/render-complete"
}'

Responses

Possible responses from this endpoint:

200

Render job created and added to queue

Example Response

JSON

{
  "_id": "render_job_789xyz",
  "videoId": "video_123abc",
  "status": "pending",
  "quality": "high",
  "format": "mp4",
  "priority": 7,
  "webhookUrl": "https://your-app.com/webhooks/render-complete",
  "estimatedDuration": 180,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "startedAt": null,
  "completedAt": null,
  "outputUrl": null
}

400

Invalid request data

Example Response

JSON

{
  "error": "Bad Request",
  "message": "video_id is required",
  "code": "MISSING_REQUIRED_FIELD"
}

401

Authentication required

Example Response

JSON

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "code": "INVALID_API_KEY"
}

404

Video not found

Example Response

JSON

{
  "error": "Not Found",
  "message": "Video not found or does not belong to user",
  "code": "VIDEO_NOT_FOUND"
}

422

Video not ready for rendering

Example Response

JSON

{
  "error": "Unprocessable Entity",
  "message": "Video media generation is not complete. Current status: generating_media",
  "code": "VIDEO_NOT_READY"
}

Try It Out

Test this endpoint directly from your browser:

API Key

Your API key is only used for this session and never stored or logged.

POST/api/queue/render

Parameters

video_idRequired

quality

format

priority

webhook_url

Generated cURL Command

Copy this command to use in your terminal

"text-blue-400 font-semibold">curl -X POST https://api.videopilot.app/api/queue/render \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "quality": "high",
  "format": "mp4",
  "priority": 5
}'

Response

Make a request to see the response here

Generate Audio

Render Status