مفاتيح API

النصوص V2

V2 هو نموذج النصوص المبسّط الذي يملكه المستخدم. يركّز على الاستجابة السريعة من الذاكرة المؤقتة، ونتائج متّسقة، ولا ترجمات مفاجئة ما لم تطلب لغة معيّنة.

POSThttps://www.youtubetranscript.dev/api/v2/transcribe
POSThttps://www.youtubetranscript.dev/api/v2/batch
GEThttps://www.youtubetranscript.dev/api/v2/jobs/{job_id}
GEThttps://www.youtubetranscript.dev/api/v2/batch/{batch_id}
POSThttps://www.youtubetranscript.dev/api/v2/channels/resolve
GEThttps://www.youtubetranscript.dev/api/v2/channels/{channel_id}
GEThttps://www.youtubetranscript.dev/api/v2/channels/history

مواصفات OpenAPI

نزّل ملف YAML لاستيراده في Postman أو Insomnia، أو لتوليد عملاء، أو للصقه في ChatGPT / Claude.

OpenAPI 3.0: V2 (موصى به)

تفريغ فيديو واحد

أسرع طريقة لمعالجة فيديو واحد في كل مرة. تُعاد النصوص المستندة إلى الترجمات المصاحبة خلال ثوانٍ؛ أما ASR فيعمل بشكل غير متزامن ويُستطلع عبر /api/v2/jobs/{job_id}.

Transcribe a single YouTube video. Returns immediately for caption-based videos; falls back to ASR (async) when allow_asr is true and captions are unavailable.

POST/api/v2/transcribe
المعاملات
videostringمطلوب

YouTube URL or 11-character video ID. Required unless upload_id is set.

upload_idstring

Transcribe an uploaded media file instead of a YouTube video (see /uploads). Forces the ASR path; webhook_url required. The upload id is returned as video_id in results.

languageISO 639-1

Preferred transcript language (e.g. en). If unavailable, captions in another language may be returned: transcript.language reports the actual language.

sourceauto | manual | asr

Preferred transcript source. Default: auto. Use asr for audio transcription (async, requires webhook_url).

allow_asrboolean

Fall back to ASR if captions fail. Required for ASR-only videos.

formatobject

{ timestamp, paragraphs, words }: include extra structure in the transcript.

webhook_urluri

When set, the response returns processing and the result is delivered to your URL. Required for ASR.

asr_optionsobject

Rich ASR config: language (+ codeSwitching, medicalMode, keyTerms), translateTo, speaker diarization (speakerLabels, speakerId + type/known values, multichannel, exact or min/max expected speakers), speech understanding (topics, summary, moderation, PII, profanity, sentiment), and formatting (punctuation, text formatting, filler words, custom date/phone/email patterns). Billable add-ons increase cost: preview with /transcribe/estimate. See the AsrOptions schema in the OpenAPI spec.

Dry-run credit estimate. Returns the ASR base cost plus any add-on surcharge for the requested asr_options without creating a job or charging credits.

POST/api/v2/transcribe/estimate
المعاملات
videostringمطلوب

YouTube URL or 11-character video ID.

sourceauto | manual | asr

Defaults to asr for cost preview.

asr_optionsobject

Same shape as /transcribe. Add-on charges are prorated by duration.

Poll a single transcription job. Use this for ASR jobs returned from /transcribe. Returns 202 while running and 200 when complete. Completed ASR jobs include asr_intelligence (summary, topics, sentiment, etc.) when those options were enabled.

GET/api/v2/jobs/{job_id}
المعاملات
job_idpathمطلوب

Identifier returned in the original transcribe response.

include_segmentsboolean

Include segment-level timestamps in the transcript payload.

include_paragraphsboolean

Include paragraph groupings.

include_wordsboolean

Include word-level timestamps (ASR only).

ارفع ملفاتك الخاصة

فرّغ ملفات الصوت أو الفيديو الخاصة بك عبر مسار ASR. ثلاث خطوات: سجّل عملية الرفع، وأرسل البايتات بطلب PUT إلى الرابط الموقّع، ثم أنهِ العملية: بعدها استدعِ /transcribe مع upload_id. تصل النتائج إلى الـ webhook الخاص بك وتُستطلع مثل أي مهمة ASR.

Register an audio/video file upload and get a signed URL. PUT the raw file bytes to signed_url (with the file's Content-Type), finalize via /uploads/{upload_id}/complete, then transcribe with upload_id on /transcribe. Max 2GB and 8 hours per file.

POST/api/v2/uploads
المعاملات
filenamestringمطلوب

Original filename. The extension is preserved for content sniffing.

mime_typestringمطلوب

Must start with audio/ or video/ (e.g. audio/mpeg, video/mp4).

size_bytesintegerمطلوب

File size in bytes. Max 2147483648 (2GB).

duration_secintegerمطلوب

Media duration in seconds. Max 28800 (8 hours). Used for the ASR credit estimate.

Finalize an upload after the PUT to signed_url succeeds. Verifies the file exists in storage and marks it ready. The upload can then be transcribed by passing upload_id to /transcribe (source="asr", webhook_url required).

POST/api/v2/uploads/{upload_id}/complete
المعاملات
upload_idpathمطلوب

Upload id returned by POST /uploads.

التفريغ على دفعات

فرّغ عدة مقاطع فيديو في طلب واحد، ثم استطلع الحالة أو استلم النتائج عبر webhook.

Submit up to 3,000 videos in one request. Returns within 2 seconds; poll the returned poll_url or wait for the webhook.

POST/api/v2/batch
المعاملات
video_idsstring[]مطلوب

Up to 3,000 IDs depending on plan. Free = 10, Basic = 500, Pro = 1,500, Business = 3,000.

languageISO 639-1

Preferred language for every video.

sourceauto | manual | asr

Preferred transcript source. Default: auto. source=asr requires webhook_url.

allow_asrboolean

Fall back to ASR when captions fail. webhook_url is required.

formatobject

{ timestamp, paragraphs, words }: applied to every result.

webhook_urluri

Delivers the completed batch payload. Required when allow_asr=true or source=asr.

asr_optionsobject

Rich ASR config applied to every video transcribed via ASR (same shape as /transcribe). Billable add-ons apply per video.

Check the status of a batch. Returns 202 while processing and 200 when results are ready. Stop polling once status is "completed", "partial", or "failed": finished batches never change, and re-fetching one more than 60 times in 24h returns 429 with a Retry-After header.

GET/api/v2/batch/{batch_id}
المعاملات
batch_idpathمطلوب

Batch identifier returned from POST /batch.

النصوص والمهام

اعرض نصوصك المحفوظة واجلبها وترجمها واحذفها، واعرض المهام غير المتزامنة. تقبل جميع نقاط النهاية المصادقة نفسها بمفتاح API.

List your transcription jobs, newest first. Filter by status and paginate. Use the returned job_id with GET /api/v2/jobs/{job_id} to fetch a transcript.

GET/api/v2/jobs
المعاملات
pagequery

Page number (default 1).

limitquery

Items per page (default 50, max 100).

statusquery

completed | processing | failed | requires_asr_confirmation.

List stored transcripts with search, status, language, and date filters. Metadata only (no full text) unless include_segments=true.

GET/api/v2/transcripts
المعاملات
pagequery

Page number (default 1).

limitquery

Items per page (default 50, max 100).

searchquery

Match video id, title, or transcript text.

statusquery

Filter by status; omit for succeeded.

languagequery

Filter by language code.

date_fromquery

ISO date-time lower bound.

date_toquery

ISO date-time upper bound.

include_segmentsquery

Include segments in each item.

Fetch the best owned transcript for a video, including asr_intelligence (summary, topics, sentiment, etc.), plus summary and mind_map when generated.

GET/api/v2/transcripts/{video_id}
المعاملات
video_idpathمطلوب

YouTube 11-character video ID.

idquery

Specific transcript/job id.

languagequery

Preferred language version.

sourcequery

auto | manual | asr.

include_timestampsquery

Include segments (default true).

Translate an owned transcript into a target language using YouTube captions or the AI provider. Returns free if you already own the translation.

POST/api/v2/transcripts/{video_id}/translate
المعاملات
video_idpathمطلوب

YouTube 11-character video ID.

target_languageISO 639-1مطلوب

Language to translate into.

source_languageISO 639-1

Source transcript language to translate from.

providerai | youtube

Translation provider.

allow_ai_fallbackboolean

Fall back to AI when YouTube has no translation.

List the languages you already own for a video plus the YouTube translation targets available for it.

GET/api/v2/transcripts/{video_id}/languages
المعاملات
video_idpathمطلوب

YouTube 11-character video ID.

include_youtube_defaultquery

Include YouTube translation targets (default true).

Delete owned transcript(s) for a video. Optional language/source query params narrow the deletion; otherwise every language/source is removed. Also deletes bulk by id via POST /api/v2/transcripts/bulk-delete.

DELETE/api/v2/transcripts/{video_id}
المعاملات
video_idpathمطلوب

YouTube 11-character video ID.

languagequery

Only delete this language.

sourcequery

Only delete this source (auto | manual | asr).

قوائم التشغيل

حوّل قائمة تشغيل إلى معرّفات فيديو، وفرّغها عبر /api/v2/batch، ثم اطّلع على دفعة القائمة وسجلّها.

Resolve a YouTube playlist by URL or ID into its video list (metadata only). Pair the returned video_id values with /api/v2/batch to transcribe them.

POST/api/v2/playlists/resolveالخطط المدفوعة
المعاملات
playlist_urlstring

Playlist URL. One of playlist_url or playlist_id is required.

playlist_idstring

Playlist ID (the list= value).

limitinteger

Max videos returned (1-100).

Fetch a playlist batch and per-video transcription job status. For overall batch progress, poll GET /api/v2/batch/{batch_id}.

GET/api/v2/playlists/{playlist_id}
المعاملات
playlist_idpathمطلوب

Batch ID returned from /playlists/resolve.

List recent playlist batches for the authenticated user.

GET/api/v2/playlists/history

القنوات

مسار تفريغ القناة:1. POST /api/v2/channels/resolve: اجلب مقاطع القناة المرفوعة (بيانات الفيديو الوصفية فقط).2. POST /api/v2/batch: أرسل قيم video_id المُعادة لبدء التفريغ. استخدم webhook_url لاستلام النتائج عند الانتهاء.3. GET /api/v2/batch/{batch_id}: استطلع الدفعة لمعرفة التقدّم العام والنتائج المجمّعة.4. GET /api/v2/channels/{channel_id}: اجلب دفعة القناة مع حالة المهمة لكل فيديو؛ وتعرض /channels/history دفعات القنوات السابقة.

Fetch the uploads of a YouTube channel by URL, channel ID, or @handle. Returns video metadata only: pair the returned video_id values with /api/v2/batch to transcribe them.

POST/api/v2/channels/resolveالخطط المدفوعة
المعاملات
channel_urlstringمطلوب

YouTube channel URL, channel ID, or @handle. One of channel_url, channel_id, or handle must be provided. Handles are the public ID without the @ (for https://www.youtube.com/@jawed, the ID is jawed).

limitinteger

Maximum uploads returned. Defaults to the plan maximum.

Per-request cap: Basic 500 videos · Pro 1,500 videos · Business 3,000 videos. Monthly job cap: Basic 3 · Pro 8 · Business unlimited.

حد المعدل

Plan-based: Free 1 req/s · Basic 25 req/s · Pro 50 req/s · Business 100 req/s. Exceeding the limit returns 429 with a Retry-After header.

Fetch a channel batch and the per-video transcription job status. For overall batch status (counts + progress), poll GET /api/v2/batch/{batch_id} instead: use this endpoint when you also need each video's individual job state.

GET/api/v2/channels/{channel_id}
المعاملات
channel_idpathمطلوب

Batch ID returned from /channels/resolve.

List recent channel batches for the authenticated user.

GET/api/v2/channels/history
المعاملات
limitquery

Max items (default 50, max 100).

التكاملات

حزم SDK رسمية، وخادم MCP لـ Claude وCursor، وGPT مخصّص، وقوالب جاهزة لـ Make وn8n.

MCP serverClaude · Cursor
المستودع

أضف خادم YouTube Transcript MCP إلى Claude Desktop أو Cursor أو أي عميل متوافق مع MCP. يضيف أدوات لتفريغ الفيديوهات وجلب النصوص الموجودة والتحقق من الاستخدام.

التثبيت والإعداد
claude mcp add --transport http youtubetranscript https://mcp.youtubetranscript.dev --header "x-api-token: YOUR_API_KEY"
Node SDKnpm
npm

أنواع TypeScript متكاملة، وإعادة المحاولة، وأدوات مساعدة للتقسيم إلى صفحات، والتحقق من توقيع webhook.

التثبيت والاستخدام
npm install youtube-transcript-api
Python SDKPyPI
PyPI

عملاء متزامنون وغير متزامنين، وملفات تعريف الأنواع، وأدوات مساعدة لمسارات الدفعات وwebhook.

التثبيت والاستخدام
pip install youtubetranscriptdevapi
Custom GPTChatGPT
فتح في ChatGPT

أضف GPT المخصّص الخاص بنا إلى ChatGPT لتلخيص أي فيديو على YouTube أو الاقتباس منه أو ترجمته أو الاستعلام عنه بلغة طبيعية. يعمل عبر /api/v2/gpt/* في الخلفية.

  • · تسجيل دخول عبر OAuth: دون مفتاح API في المحادثة
  • · بديل ASR عند غياب الترجمات المصاحبة
  • · اقتباسات مع الطوابع الزمنية وروابط المصدر
  • · تجربة مجانية لكل حساب
Make.com & n8nبدون كود
تصفّح القوالب

استورد القالب (أو انسخ المقتطف) لإضافة التفريغ إلى عمليات الأتمتة الحالية: Notion وSheets وSlack وAirtable ومسارات على غرار Zapier.

وحدة Make.com
Module: HTTP > Make a request
- URL: https://www.youtubetranscript.dev/api/v2/transcribe
- Method: POST
- Headers:
    Authorization: Bearer {{connection.api_key}}
    Content-Type: application/json
- Body type: Raw / JSON
- Request content:
    {
      "video": "{{1.video_url}}",
      "format": { "timestamp": true }
    }
عقدة HTTP في n8n
{
  "name": "Transcribe Video",
  "type": "n8n-nodes-base.httpRequest",
  "parameters": {
    "method": "POST",
    "url": "https://www.youtubetranscript.dev/api/v2/transcribe",
    "authentication": "genericCredentialType",
    "genericAuthType": "httpHeaderAuth",
    "sendBody": true,
    "specifyBody": "json",
    "jsonBody": "={ \"video\": $json.video_url }"
  }
}
Postman / OpenAPIبنقرة واحدة
مجموعة Postman

استورد مواصفات OpenAPI إلى Postman أو Insomnia أو أي أداة تدعم OpenAPI 3.

الأخطاء

تُعيد الأخطاء جسم JSON يحتوي على code وmessage. وتعكس حالة HTTP فئة الخطأ.

حالة HTTPرمز الخطأالوصف
400invalid_requestInvalid JSON or missing required fields
401invalid_api_keyMissing or invalid API key
402payment_requiredInsufficient credits
404no_captionsNo captions available and ASR not used
429rate_limit_exceededToo many requests, check Retry-After
500internal_errorServer error, retry with backoff

حدود المعدل والحصص

حدود لكل خطة على الطلبات المستمرة وأحجام الدفعات. تجاوز الحد يُعيد 429 مع ترويسة Retry-After.

الخطةالطلباتحجم الدفعة
Free1 req/s10 videos
Basic25 req/s500 videos
Pro50 req/s1,500 videos
Business100 req/s3,000 videos

الدعم

تحتاج مساعدة؟ تواصل معنا: عادةً نردّ خلال ساعات قليلة.

وثائق API - YouTube Transcript API