transcript.imDocs
DocumentationAPI Reference

Get transcript

GET
/v1/library/transcripts/{platform}/{externalId}

Retrieve a transcript saved in the authenticated owner's library. Returns 404 if not owned; does not trigger extraction or charge credits.

AuthorizationBearer <token>

Session token (cookie-based auth in browser) or developer API key (tr_ prefix). API keys require the transcripts scope for /v1/transcript and the batches scope for /v1/batch.

In: header

Path Parameters

platform*string

Value in

  • "youtube"
  • "tiktok"
  • "instagram"
  • "upload"
  • "linkedin"
  • "twitter"
externalId*string

Platform-native content id (e.g. dQw4w9WgXcQ for YouTube).

Query Parameters

language?string

Exact language tag to look up. Omitted returns the latest cached result for the asset, regardless of language.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/library/transcripts/youtube/string"
{  "transcript": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "platform": "youtube",    "externalId": "string",    "sourceUrl": "http://example.com",    "lang": "string",    "title": "string",    "channel": "string",    "creatorName": "string",    "creatorHandle": "string",    "creatorUrl": "string",    "thumbnailUrl": "string",    "durationSec": 0,    "publishedAt": "2019-08-24T14:15:22Z",    "metadata": {},    "source": "youtube_transcript_api",    "status": "pending",    "segments": [      {        "text": "string",        "start": 0,        "duration": 0      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "cached": true}