Render routes

The routes of the renders: a new transcription or burn in the queue, the renders of a video, one render, and the output file of a render.

Source file: captionbob_server/render_routes.js

POST /api/videos/:videoId/renders

Access: any. A route that a dashboard login or an API key may call.

Path values: videoId.

POST /api/videos/:videoId/renders with {"kind"}: "transcribe" or "burn". A burn burns the current version. A video has one render at a time. A burn of a style with emoji layers needs the emoji index folder.

GET /api/videos/:videoId/renders

Access: any. A route that a dashboard login or an API key may call.

Path values: videoId.

GET /api/videos/:videoId/renders. The renders of a video, the newest first.

GET /api/renders/:renderId

Access: any. A route that a dashboard login or an API key may call.

Path values: renderId.

GET /api/renders/:renderId. One render with its state and progress.

GET /api/renders/:renderId/file

Access: any. A route that a dashboard login or an API key may call.

Path values: renderId.

GET /api/renders/:renderId/file. The output file of a finished render, whole or as one byte range: the burned video of a burn, or the transcript JSON of a transcription.