Transcribes the timeline's audio and replaces its captions with timed caption clips; other text stays. Free; long timelines take up to a few minutes. Uses the processes:write scope.
Authorization
bearerAuth processes:writeIn: header
Scope: processes:write
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/sessions/string/timeline/captions" \ -H "Content-Type: application/json" \ -d '{}'{ "sessionId": "string", "exists": true, "name": "string", "duration": 0, "clips": [ { "clipId": "string", "kind": "video", "assetId": "string", "track": 1, "startTime": 0, "endTime": 0, "trimStart": 0, "trimEnd": 0, "volume": 0 } ], "transitions": [ {} ], "textClips": [ {} ], "mutedTracks": [ 0 ], "gaps": [ {} ], "revision": 0, "updatedAt": "2019-08-24T14:15:22Z", "webUrl": "http://example.com", "captionCount": 0}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Cancel a process POST
Cancels a process started through the API while it hasn't been sent to the provider, usually its first few seconds, and refunds it in full. It then reads as failed with error.code cancelled, and process.failed goes to webhooks. Once the provider has accepted it, the call answers 409 conflict and the process runs to the end (a failure is refunded automatically). Canvas runs and wallet-funded runs can't be cancelled.
Finalize a direct upload POST
Call after PUTting the bytes to uploadUrl. Probes the file (size limits, dimensions/duration), stores a normalized copy, and returns the finished asset. Idempotent: completing again returns the same asset.