{"openapi":"3.1.0","info":{"title":"Transkrio API","description":"Get the transcript of a YouTube or TikTok video, an Instagram Reel or a podcast episode with one request. Authenticate with the `x-api-key` header. 1 credit per successful request; media without captions is transcribed from the audio for 1 credit per started minute. Failed requests are free.","version":"0.1.0"},"paths":{"/v1/transcript":{"get":{"summary":"Get the transcript of a video, Reel or podcast episode","description":"Captions are used when they exist (1 credit). Media without them is transcribed with\nspeech-to-text for 1 credit per started minute. Long audio may answer **202** with\n`status: processing`: repeat the same request after `retry_after` seconds. Failures are free.","operationId":"transcript_v1_transcript_get","parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"YouTube, TikTok or Instagram URL, YouTube video id, podcast RSS feed, Apple Podcasts link or audio file URL","title":"Url"},"description":"YouTube, TikTok or Instagram URL, YouTube video id, podcast RSS feed, Apple Podcasts link or audio file URL"},{"name":"lang","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO language code, e.g. en, es. Default: best available","title":"Lang"},"description":"ISO language code, e.g. en, es. Default: best available"},{"name":"format","in":"query","required":false,"schema":{"enum":["json","text","srt","vtt","markdown"],"type":"string","description":"json: segments and text; text: plain text; srt/vtt: subtitles; markdown: document for LLMs and agents","default":"json","title":"Format"},"description":"json: segments and text; text: plain text; srt/vtt: subtitles; markdown: document for LLMs and agents"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata":{"get":{"summary":"Get video or episode metadata","operationId":"metadata_v1_metadata_get","parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"YouTube, TikTok or Instagram URL, YouTube video id, podcast RSS feed, Apple Podcasts link or audio file URL","title":"Url"},"description":"YouTube, TikTok or Instagram URL, YouTube video id, podcast RSS feed, Apple Podcasts link or audio file URL"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos":{"get":{"summary":"List the videos of a playlist or channel, or a podcast's episodes","description":"Costs 1 credit per successful listing. Pass the returned URLs to `/v1/batch` to get their transcripts.","operationId":"videos_v1_videos_get","parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"YouTube playlist URL or id, channel URL (/@handle, /channel/UC...) or @handle, podcast RSS feed or Apple Podcasts show link","title":"Url"},"description":"YouTube playlist URL or id, channel URL (/@handle, /channel/UC...) or @handle, podcast RSS feed or Apple Podcasts show link"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum number of videos, newest first for channels","default":50,"title":"Limit"},"description":"Maximum number of videos, newest first for channels"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch":{"post":{"summary":"Get the transcripts of several videos or episodes at once","description":"Each transcript costs what a separate call would, failed items are free. Results keep the\norder of `urls`; each one has `ok` and either the transcript or an `error`. Items with error code\n`processing` are still being transcribed: send them again later.","operationId":"batch_v1_batch_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage":{"get":{"summary":"Credits left and usage in the last 30 days","operationId":"usage_v1_usage_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/signup":{"post":{"summary":"Get a free API key by email","operationId":"signup_v1_signup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BatchRequest":{"properties":{"urls":{"items":{"type":"string"},"type":"array","title":"Urls","description":"Up to 50 URLs: YouTube, TikTok, Instagram, podcast episodes or audio files"},"lang":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lang","description":"ISO language code, e.g. en, es. Default: best available"},"format":{"type":"string","enum":["json","text"],"title":"Format","description":"json: segments and text; text: text only","default":"json"}},"type":"object","required":["urls"],"title":"BatchRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SignupIn":{"properties":{"email":{"type":"string","maxLength":320,"title":"Email"},"source":{"anyOf":[{"$ref":"#/components/schemas/SourceIn"},{"type":"null"}]}},"type":"object","required":["email"],"title":"SignupIn"},"SourceIn":{"properties":{"landing":{"type":"string","title":"Landing","default":""},"referrer":{"type":"string","title":"Referrer","default":""},"utm_source":{"type":"string","title":"Utm Source","default":""},"utm_medium":{"type":"string","title":"Utm Medium","default":""},"utm_campaign":{"type":"string","title":"Utm Campaign","default":""},"utm_term":{"type":"string","title":"Utm Term","default":""},"utm_content":{"type":"string","title":"Utm Content","default":""},"gclid":{"type":"boolean","title":"Gclid","default":false}},"type":"object","title":"SourceIn","description":"First-touch attribution recorded by the website (see layout.ATTRIBUTION_JS). All optional, all untrusted."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}