Get All render by video Id
curl --request GET \
--url https://api.videoaiditor.com/v1/renders \
--header 'x-api-key: <api-key>'{
"data": [
{
"_id": "<string>",
"status": "pending",
"outputUrl": "<string>",
"videoId": "<string>",
"error": "<string>",
"videoData": {
"_id": "<string>",
"version": "<string>",
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
},
"redirectUrl": "<string>"
},
"clips": [
{
"type": "video",
"name": "<string>",
"source": "<string>",
"volume": 1,
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"textProperties": {
"content": "<string>",
"fontSize": 16,
"fontWeight": 400,
"fontFamily": "Arial",
"color": "#000000",
"backgroundColor": "transparent",
"textAlign": "left",
"fontStyle": "normal",
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"underline": false
},
"captionProperties": {
"words": [
{
"start": 123,
"end": 123,
"word": "<string>"
}
],
"highlightTextProperties": {
"fontSize": 24,
"color": "#000000",
"fontFamily": "Montserrat",
"fontWeight": 400,
"fontStyle": "normal",
"underline": false,
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"backgroundColor": "<string>"
},
"nonHighlightTextProperties": {
"fontSize": 123,
"color": "<string>",
"fontFamily": "<string>",
"fontWeight": 123,
"fontStyle": "<string>",
"underline": true,
"padding": 123,
"strokeWidth": 123,
"strokeColor": "<string>",
"borderWidth": 123,
"borderColor": "<string>",
"backgroundColor": "<string>"
},
"textAlign": "center",
"maxWidth": 500,
"maxWordsInFrame": 5
},
"id": "<string>"
}
],
"additional": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {}
}Authorizations
Enter your API key here
Query Parameters
Video ID
Response
Array of render data
Unique identifier of the render
Current status of the render
pending, processing, completed, failed Creation timestamp
Last update timestamp
URL to the rendered video file
Video ID
Error message if render failed
API video data
Unique identifier of the video
Version number of the video format
Video metadata including redirect URL
Name of the video project
Background color of the canvas in hex format
Total duration of the video in milliseconds
Frames per second. Common values: 24, 30, 60
URL to redirect to after video processing completes
Array of clips in the video
Type of clip. Possible values: video, image, text, audio, caption
video, image, text, audio, caption URL to the source media file (video, image, or audio)
Timing properties for when the clip plays
Start time in milliseconds when the clip should begin playing
End time in milliseconds when the clip should stop playing
Time offset in milliseconds to start playing from within the source media
Position properties for where the clip appears
Horizontal position in pixels from left edge of canvas
Vertical position in pixels from top edge of canvas
Z-index for layering clips. Higher numbers appear on top
Unique identifier for the clip
Optional display name for the clip
Audio volume level. 0 is muted, 1 is full volume
Text styling properties, only used for text clips
The text content to display
Font size in pixels
Font weight (100-900). 400 is normal, 700 is bold
Font family name. Common values: Arial, Times New Roman, Helvetica
Text color in hex format
Background color in hex format
Text alignment. Possible values: left, center, right, justify
Font style. Possible values: normal, italic
Padding around the text in pixels
Width of the text stroke/outline in pixels
Color of the text stroke/outline in hex format
Width of the text border in pixels
Color of the text border in hex format
Whether to underline the text
Caption properties, used for caption clips
Array of words with their timing information
Text style properties for highlighted words
Text style properties for non-highlighted words
Text alignment. Possible values: left, center, right, justify
Maximum width of the caption text in pixels
Maximum number of words to show in a single frame
Creation timestamp
Last update timestamp
Additional custom properties
Pagination information
curl --request GET \
--url https://api.videoaiditor.com/v1/renders \
--header 'x-api-key: <api-key>'{
"data": [
{
"_id": "<string>",
"status": "pending",
"outputUrl": "<string>",
"videoId": "<string>",
"error": "<string>",
"videoData": {
"_id": "<string>",
"version": "<string>",
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
},
"redirectUrl": "<string>"
},
"clips": [
{
"type": "video",
"name": "<string>",
"source": "<string>",
"volume": 1,
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"textProperties": {
"content": "<string>",
"fontSize": 16,
"fontWeight": 400,
"fontFamily": "Arial",
"color": "#000000",
"backgroundColor": "transparent",
"textAlign": "left",
"fontStyle": "normal",
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"underline": false
},
"captionProperties": {
"words": [
{
"start": 123,
"end": 123,
"word": "<string>"
}
],
"highlightTextProperties": {
"fontSize": 24,
"color": "#000000",
"fontFamily": "Montserrat",
"fontWeight": 400,
"fontStyle": "normal",
"underline": false,
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"backgroundColor": "<string>"
},
"nonHighlightTextProperties": {
"fontSize": 123,
"color": "<string>",
"fontFamily": "<string>",
"fontWeight": 123,
"fontStyle": "<string>",
"underline": true,
"padding": 123,
"strokeWidth": 123,
"strokeColor": "<string>",
"borderWidth": 123,
"borderColor": "<string>",
"backgroundColor": "<string>"
},
"textAlign": "center",
"maxWidth": 500,
"maxWordsInFrame": 5
},
"id": "<string>"
}
],
"additional": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {}
}