transcript.imDocs
DocumentationAPI Reference

Create batch

POST
/v1/batch

Create a batch job. The body's shape selects the mode — no mode field:

  • { urls: [...] } — mixed-platform URLs (max 500 resolved items).
  • { playlistId | playlist } — a YouTube playlist id or URL.
  • { channelId | channel } — a YouTube channel id, @handle, or URL.

Billing: batch extraction is free (0 credits); exports are Pro-gated.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/batch" \  -H "Content-Type: application/json" \  -d '{    "urls": [      "string"    ],    "language": "en"  }'
{  "batch": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "status": "string",    "counts": {      "total": 0,      "pending": 0,      "success": 0,      "failed": 0    }  }}