Render
AI-generatedOverview
This node, named "Video Render," allows users to render a video by sending URLs of media files to a multipart render API. It supports combining a base video with optional audio and overlay elements such as images and text. The node sends these inputs to an external rendering service and returns a downloadable URL for the processed video.
Common scenarios include:
- Adding background music or audio tracks to existing videos.
- Overlaying images or text at specified positions on the video.
- Adjusting video properties like saturation and quality (CRF).
- Creating videos formatted for different aspect ratios (vertical, horizontal, square).
Practical example: A social media content creator could use this node to automatically add branded overlays and background music to raw video clips before publishing.
Properties
| Name | Meaning |
|---|---|
| Video URL | Public URL of the video file to render (required). |
| Audio URL | Public URL of the audio file to mix into the video (optional). |
| Overlay Image URL | Public URL of an image to overlay on the video (optional). |
| Overlay Text | Text string to overlay on the video. |
| Position | Position of the overlay on the video; options: Top, Center, Bottom. |
| Target | Aspect ratio target for the output video; options: Vertical, Horizontal, Square. |
| Random Audio Start | Boolean to randomize the start position of the audio track when mixing (default: true). |
| Dark Overlay | Boolean to apply a dark overlay behind text/image overlays (default: true). |
| Dark Overlay Opacity | Opacity level of the dark overlay, from 0 to 1 (default: 0.5). |
| Mix Audio | Boolean to enable mixing the audio track with the video’s original audio (default: false). |
| CRF | Constant Rate Factor controlling video quality/compression; range 0 (best) to 51 (worst). |
| Saturation Boost | Numeric adjustment to video saturation; range -5 to 5 (default: 0). |
| Endpoint Path | String to override the default API endpoint path (default: "/render"). |
Output
The node outputs JSON data containing:
statusCode: HTTP status code returned by the render API.download_url: URL where the rendered video can be downloaded.video_url: Same asdownload_url(redundant field for convenience).
No binary data is output directly by the node; instead, it provides a URL to access the rendered video file.
Dependencies
- Requires an external rendering API accessible via HTTP POST requests.
- Needs an API authentication token credential configured in n8n to authorize requests.
- Uses multipart form-data to send input URLs and parameters to the API.
- The base URL and token for the API must be set in the node credentials.
- Optional override of the API endpoint path is supported.
Troubleshooting
- Missing Required Parameter: If the "Video URL" is not provided, the node throws an error indicating the missing parameter.
- Invalid API Response: If the response from the render API does not contain a
download_url, an error is thrown showing the full response body for debugging. - HTTP Errors: Network issues or invalid credentials may cause HTTP request failures; ensure the API token and base URL are correct.
- Parameter Validation: Ensure numeric parameters like CRF and opacity are within allowed ranges to avoid API rejection.
Links and References
- No direct links available from the source code.
- Users should refer to their rendering API documentation for details on accepted parameters and response formats.