Raw schema
{
"type": "object",
"properties": {
"transcript_id": {
"type": "string",
"pattern": "^tr_[0-9a-f]{16}$",
"description": "The transcript_id from transcribe_media, such as tr_a6f8c87a9b2eb748. Give exactly one of transcript_id or subtitles."
},
"subtitles": {
"type": "string",
"maxLength": 60000,
"description": "The full text of an SRT or WebVTT file the user owns or may use, with timing lines such as 00:00:01,000 --> 00:00:03,000. Give exactly one of transcript_id or subtitles. With subtitles, source_lang and confirm_rights true are required."
},
"target_lang": {
"type": "string",
"enum": [
"af",
"am",
"ar",
"ast",
"az",
"ba",
"be",
"bg",
"bn",
"br",
"bs",
"ca",
"ceb",
"cs",
"cy",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"ff",
"fi",
"fr",
"fy",
"ga",
"gd",
"gl",
"gu",
"ha",
"he",
"hi",
"hr",
"ht",
"hu",
"hy",
"id",
"ig",
"ilo",
"is",
"it",
"ja",
"jv",
"ka",
"kk",
"km",
"kn",
"ko",
"lb",
"lg",
"ln",
"lo",
"lt",
"lv",
"mg",
"mk",
"ml",
"mn",
"mr",
"ms",
"my",
"ne",
"nl",
"no",
"ns",
"oc",
"or",
"pa",
"pl",
"ps",
"pt",
"ro",
"ru",
"sd",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"ss",
"su",
"sv",
"sw",
"ta",
"th",
"tn",
"tr",
"uk",
"ur",
"uz",
"vi",
"wo",
"xh",
"yi",
"yo",
"zh",
"zu"
],
"description": "Language to translate into, as a two-letter code such as es, fr, de, ja, ar or hi."
},
"source_lang": {
"type": "string",
"enum": [
"af",
"am",
"ar",
"ast",
"az",
"ba",
"be",
"bg",
"bn",
"br",
"bs",
"ca",
"ceb",
"cs",
"cy",
"da",
"de",
"el",
"en",
"es",
"et",
"fa",
"ff",
"fi",
"fr",
"fy",
"ga",
"gd",
"gl",
"gu",
"ha",
"he",
"hi",
"hr",
"ht",
"hu",
"hy",
"id",
"ig",
"ilo",
"is",
"it",
"ja",
"jv",
"ka",
"kk",
"km",
"kn",
"ko",
"lb",
"lg",
"ln",
"lo",
"lt",
"lv",
"mg",
"mk",
"ml",
"mn",
"mr",
"ms",
"my",
"ne",
"nl",
"no",
"ns",
"oc",
"or",
"pa",
"pl",
"ps",
"pt",
"ro",
"ru",
"sd",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"ss",
"su",
"sv",
"sw",
"ta",
"th",
"tn",
"tr",
"uk",
"ur",
"uz",
"vi",
"wo",
"xh",
"yi",
"yo",
"zh",
"zu"
],
"description": "Language of the text, as a two-letter code such as en. Required with subtitles; for a transcript the detected language is used when left out."
},
"confirm_rights": {
"type": "boolean",
"description": "true, and only after the user has said they own this recording or have the rights to translate it. Required with subtitles; false is refused with rights_not_confirmed."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"srt",
"vtt",
"dub_script"
]
},
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"description": "What to return (default all three): translated SRT captions, translated VTT captions, a dub script with one spoken line per segment."
},
"library_id": {
"type": "string",
"pattern": "^lib_[0-9a-f]{24}$",
"description": "The library_id an earlier transcribe_media answer returned, such as lib_9b6a98861ea4f54bff8f5cf1. It names the set of transcripts that call saved. Pass it when that answer had one; leave it out when it was null or absent."
}
},
"required": [
"target_lang"
],
"dependentRequired": {
"subtitles": [
"source_lang",
"confirm_rights"
]
},
"additionalProperties": false
}