Skip to main content
GET
Get Video Render Job by ID

Overview

This endpoint retrieves the current status and results of a video render job using its unique job ID. While rendering is in progress, it returns the job status along with render progress percentage and state. Once the render completes, it returns the full set of output URLs for the rendered video, audio, subtitles, and thumbnail.
A valid API key is required to use this endpoint. Obtain your API key from the API Access page in your Pictory dashboard.

API Endpoint


Request Parameters

Path Parameters

uuid
required
The unique identifier (UUID) of the video render job. This value is the jobId returned by the Render from Preview, Render Video, Render Storyboard Video, or Render Project endpoints.Example: "265a7c1a-4985-4058-9208-68114f131a2b"

Headers

string
required
API key for authentication (starts with pictai_)

Response

In-Progress Response

Returned while the video is being rendered. The response includes progress information once rendering has started:
string
The unique identifier of the render job
boolean
true while the job is processing
object
string
"in-progress": the video is still being rendered
number
Rendering progress as a percentage (0–100). Present only after rendering has started.
string
Descriptive progress message (e.g., "Generating video"). Present only after rendering has started.
string
Current render state (e.g., "RUNNING"). Present only after rendering has started.

Failed Response

Returned when the render job has failed:
string
The unique identifier of the render job
boolean
false when the job has failed
object
string
"failed": the video render has failed
string
Error code identifying the failure type
string
Descriptive message explaining the cause of the failure

Completed Response

Returned when the render has finished successfully. The response contains all output URLs:
string
The unique identifier of the render job
boolean
true when the job has completed successfully
object
Contains the complete render output.
string
"completed": the video has been rendered successfully
number
100: rendering is complete
string
Direct download URL for the rendered video file (MP4)
string
Shareable URL for the rendered video
string
Embeddable URL for the rendered video, suitable for iframe integration
string
Direct download URL for the audio track (MP3)
string
URL for the video thumbnail image (JPG)
string
URL for the SRT subtitle file
string
URL for the plain text transcript file
string
URL for the WebVTT subtitle file
number
Total duration of the rendered video in seconds
number
Time taken to encode and render the video in seconds
number
Total AI credits consumed for generating AI visuals (images and video clips) during rendering. Present only when the video includes scenes with aiVisual configuration. The value is the sum of credits used across all AI-generated scenes.

Response Examples


Completed Response Fields


Code Examples

Replace YOUR_API_KEY with your actual API key and use the jobId returned from any render endpoint.

Render Progress Stages

The render job progresses through the following stages:

Polling Best Practices

Use a polling interval of 10–30 seconds when checking job status. Polling too frequently may result in rate limiting.
  1. Use webhooks when possible. Configure a webhook URL in the original render request to receive automatic notification when the job completes, rather than polling.
  2. Monitor renderProgress. Use the renderProgress field to display progress to users. This field provides a percentage value from 0 to 100.
  3. Implement timeouts. Set a maximum wait time based on expected video length. Longer videos require more rendering time.
  4. Cache results. Once a render job completes, store the output URLs locally. Completed job data may be cleaned after a retention period.
  5. Handle failures gracefully. Inspect error_code and error_message in failed responses to determine whether the issue is recoverable (for example, an invalid voice name can be corrected and the request resubmitted).