Skip to main content
POST
Generate the transcript
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Path Parameters

id
string
required

The recording's id (UUID) or its public_link_id (the short code in the watch URL). Both are accepted.

Body

application/json
language
string

Language code to transcribe in, for example en. Send auto, or leave it out, to let the transcription engine detect the language.

Example:

"en"

Response

Transcript generation was queued.

recording_id
string

Public link identifier of the recording.

status
enum<string>

Always triggered. Generation runs in the background.

Available options:
triggered