Yapper Docs
Api reference
POST
/sessions/{sessionId}/timeline/captions

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:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

sessionId*string

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"  }}