Get Video Render Job by ID
Pictory Jobs
Get Video Render Job by ID
Retrieve the status and results of a video render job
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 processingobject
string
"in-progress": the video is still being renderednumber
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 failedobject
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 successfullyobject
Contains the complete render output.
string
"completed": the video has been rendered successfullynumber
100: rendering is completestring
Direct download URL for the rendered video file (MP4)
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
Render Progress Stages
The render job progresses through the following stages:Polling Best Practices
-
Use webhooks when possible. Configure a
webhookURL in the original render request to receive automatic notification when the job completes, rather than polling. -
Monitor renderProgress. Use the
renderProgressfield to display progress to users. This field provides a percentage value from 0 to 100. - Implement timeouts. Set a maximum wait time based on expected video length. Longer videos require more rendering time.
- Cache results. Once a render job completes, store the output URLs locally. Completed job data may be cleaned after a retention period.
-
Handle failures gracefully. Inspect
error_codeanderror_messagein failed responses to determine whether the issue is recoverable (for example, an invalid voice name can be corrected and the request resubmitted).
