API

Video

Video projects: proxies and mixdowns uploaded in parts, the poster frame, transcriptions into captions, and the app's limits and export presets.

See Video. A video project is an office file (application/vnd.si.video), so it's created, opened, co-edited, versioned and commented on through the Documents, Sheets and Slides routes with kind: "video", and its media are Drive files. These routes add what Video keeps beside a project. They're under /v1/orgs/:orgId/video (an organization's projects) and /v1/me/video (your own); an organization's need a plan with Documents, Sheets, Slides and Video.

Proxies and mixdowns upload like Drive's files: POST files/:fileId/proxies answers the part size and links for the first parts; PUT each part's bytes to its link, ask …/parts for more links, then …/complete. They're stored with the project, count against its space's storage, can be read by anyone who can read the project (GET /v1/orgs/:orgId/office/files/:fileId/media/:mediaId), and go when it's deleted. Making a copy of a project leaves its proxies behind.

Transcriptions run on Amazon Transcribe in the platform's home region and take a minute or more. The caption track arrives in the project by itself, so people with it open see it appear; GET …/transcriptions/:transcriptionId reports progress. Each person has a daily allowance of minutes (video.transcribeMinutesPerDay).

Times are in flicks, 1/705,600,000 of a second, as in the project itself.

Changes need drive:write as well as edit access to the project.

Every route below, with its parameters, request and response, errors and samples, is in the API reference.

Route	What it does
`GET /v1/orgs/:orgId/video/files/:fileId/proxies`	The project's finished proxies: each one's media item (`mediaRef`), name, type and size. Read a proxy through Office's `GET …/office/files/:fileId/media/:mediaId`.
`POST /v1/orgs/:orgId/video/files/:fileId/proxies`	Starts an upload into the project in parts: a proxy of a media item (`mediaRef`, MP4 or WebM, up to `video.proxyMb`) or, with `purpose: "audio"`, the mixdown to transcribe. Answers `mediaId`, `partSize`, `partCount` and links for the first parts. Editors only.
`POST /v1/orgs/:orgId/video/files/:fileId/proxies/:mediaId/parts`	Links for more parts (`parts`, 1 to 100 part numbers).
`POST /v1/orgs/:orgId/video/files/:fileId/proxies/:mediaId/complete`	Finishes the upload once every part is in; it then counts against the space's storage.
`DELETE /v1/orgs/:orgId/video/files/:fileId/proxies/:mediaId`	Deletes a proxy, a mixdown or an unfinished upload of one, giving its storage back (when its media item leaves the project, or to make it again). Editors only.
`PUT /v1/orgs/:orgId/video/files/:fileId/poster`	Saves the project's poster frame (the body: a WebP or JPEG of at most 1 MB). Drive's thumbnail of the project follows. Editors only.
`POST /v1/orgs/:orgId/video/files/:fileId/transcriptions`	Captions from speech: the uploaded mixdown (`audioMediaId`, `duration` in flicks) or one media item (`source: "media"`, `mediaId`) into a new caption track of `sequenceId` from `from`, in `language` (or `auto`), with up to `speakers` voices told apart. 202 with the job; the track arrives in the project when it's done. Counts against your daily transcription minutes.
`GET /v1/orgs/:orgId/video/files/:fileId/transcriptions/:transcriptionId`	A transcription job: `status` (running, done, failed), the caption track it made (`trackId`) and its cue count, or why it failed.
`GET /v1/me/video/files/:fileId/proxies`	The project's finished proxies: each one's media item (`mediaRef`), name, type and size. Read a proxy through Office's `GET …/office/files/:fileId/media/:mediaId`.
`POST /v1/me/video/files/:fileId/proxies`	Starts an upload into the project in parts: a proxy of a media item (`mediaRef`, MP4 or WebM, up to `video.proxyMb`) or, with `purpose: "audio"`, the mixdown to transcribe. Answers `mediaId`, `partSize`, `partCount` and links for the first parts. Editors only.
`POST /v1/me/video/files/:fileId/proxies/:mediaId/parts`	Links for more parts (`parts`, 1 to 100 part numbers).
`POST /v1/me/video/files/:fileId/proxies/:mediaId/complete`	Finishes the upload once every part is in; it then counts against the space's storage.
`DELETE /v1/me/video/files/:fileId/proxies/:mediaId`	Deletes a proxy, a mixdown or an unfinished upload of one, giving its storage back (when its media item leaves the project, or to make it again). Editors only.
`PUT /v1/me/video/files/:fileId/poster`	Saves the project's poster frame (the body: a WebP or JPEG of at most 1 MB). Drive's thumbnail of the project follows. Editors only.
`POST /v1/me/video/files/:fileId/transcriptions`	Captions from speech: the uploaded mixdown (`audioMediaId`, `duration` in flicks) or one media item (`source: "media"`, `mediaId`) into a new caption track of `sequenceId` from `from`, in `language` (or `auto`), with up to `speakers` voices told apart. 202 with the job; the track arrives in the project when it's done. Counts against your daily transcription minutes.
`GET /v1/me/video/files/:fileId/transcriptions/:transcriptionId`	A transcription job: `status` (running, done, failed), the caption track it made (`trackId`) and its cue count, or why it failed.
`GET /v1/video/config`	Video's limits (`limits`, from Admin → Limits), the export presets (`presets`, with the platform's changes) and what Transcribe offers (`transcribe`: whether it's on, its languages and the minutes allowed). People only.