Create Render
POST /api/v1/renders
Request payload data
{}
duration_ms?: number
fps?: number
height?: number
html?: string
md5?: string
metadata?: Record<string, string>
output?:
{}
| audio:
{}
codec: "aac"
container: "mp4"
video:
{}
codec: "h264"
{}
| container: "jpeg"
quality?: number
{}
| compression?: number
container: "png"
transparency?: boolean
{}
compression?: number
container: "webp"
quality?: number
transparency?: boolean
strategy?: "v1"
width?: number
work_slice_ms?: number
Response payload data
{}
id: string
md5: null | string
metadata: Record<string, string>
status: string
Upload Render
POST /api/v1/renders/:id/upload
No doc item found for UploadRenderResult
Get Render Info
GET /api/v1/renders/:id
No doc item found for GetRenderInfoResult
Lookup Render by MD5
GET /api/v1/renders/md5/:md5
Response payload data
{}
id: string
md5: null | string
metadata: Record<string, string>
status: string
Get Render Progress
GET /api/v1/renders/:id/progress
No doc item found for GetRenderProgressResult
Download Render
GET /api/v1/renders/:id.mp4
No doc item found for DownloadRenderResult