Skip to content

Variant Resource

Definition

This is an object representing a variant of a Transcript.

A variant can be a translation to a different language.

Each Variant can contain multiple Versions. Every time the text is edited a new Version is created.

You can retrieve it to see the information of the variant object.

ENDPOINTS

GET /v1/transcripts/{TRANSCRIPT_ID}/variants

GET /v1/transcripts/{TRANSCRIPT_ID}/variants/{VARIANT_ID}

POST /v1/transcripts/{TRANSCRIPT_ID}/variants

DELETE /v1/transcripts/{TRANSCRIPT_ID}/variants/{VARIANT_ID}

Attributes

Top level attributes

Name Type Description
id string Global identifier to access the actual resource
language string An automatically detected or explicitly set language.
name string A custom or auto-generated name of the transcription variant
time_created string Creation time of the transcript (ISO Time String)
time_updated string Modification time of the variant (ISO Time String)

JSON Example

{
    "id": "b6b6726e-9f5a-4542-b497-30fe08b0ea43",
    "language": "German",
    "name": "German Translation",
    "time_created": "2024-05-03 12:19:30.454000",
    "time_updated": "2024-05-03 12:19:30.454000"
}