Skip to content

Latest commit

 

History

History
72 lines (54 loc) · 3.63 KB

README.md

File metadata and controls

72 lines (54 loc) · 3.63 KB

Transcript Dock OpenAPI definition

The public OpenAPI 3.1 definition of the Transcript Dock API: transcripts from YouTube, TikTok, Instagram and your own media through one API.

  • openapi.yaml in this repository
  • Raw file: https://raw.githubusercontent.com/TranscriptDock/transcriptdock-openapi/main/openapi.yaml
  • Always current on the website: https://www.transcriptdock.com/docs/openapi.yaml

This file holds the public endpoints only: jobs, batches, video and language discovery, transcripts and exports, uploads, usage and webhook endpoints. Dashboard, sign in and provider callback routes are left out.

Use it

Postman, Insomnia, Bruno or Hoppscotch. Import the raw file URL above. Set the collection's bearer token to your API key (td_live_...). Keep the key out of shared workspaces and exported collections.

Generate a client. Prefer an official SDK below. For another language, any OpenAPI 3.1 generator works, for example:

npx @openapitools/openapi-generator-cli generate \
  -i https://www.transcriptdock.com/docs/openapi.yaml -g kotlin -o transcriptdock-kotlin

Generated clients do not add the safety rules the official SDKs enforce. Before you ship one:

  • Creating jobs can spend credits. Set max_credits on every submission.
  • Send an Idempotency-Key header with POST /v1/jobs, /v1/batches, /v1/video-discoveries, /v1/language-discoveries and /v1/jobs/{id}/retry. Reuse the same key and exact body if a response is lost, instead of submitting again.
  • Do not follow redirects with the API key attached. Call https://www.transcriptdock.com directly; the apex domain redirects.
  • Upload file bytes to the signed upload URL without your API key.

Official SDKs

Language Package Repository
JavaScript and TypeScript npm install transcriptdock transcriptdock-js
Python pip install transcriptdock transcriptdock-python
Dart and Flutter dart pub add transcriptdock transcriptdock-dart
Go go get github.com/TranscriptDock/transcriptdock-go transcriptdock-go
Java and Kotlin com.transcriptdock:transcriptdock transcriptdock-java
Rust cargo add transcriptdock transcriptdock-rust
Swift Swift Package Manager transcriptdock-swift
Ruby gem install transcriptdock transcriptdock-ruby
PHP composer require transcriptdock/transcriptdock transcriptdock-php
.NET dotnet add package TranscriptDock transcriptdock-dotnet

Agents and automation: MCP server, n8n node and Apify Actor.

Update this file

openapi.yaml is generated. Do not edit it by hand.

npm ci
npm run extract   # downloads the website's definition and keeps the public part
npm run lint

CI lints every push and warns when the committed file differs from the website.

License

MIT. See LICENSE.