> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# YouTube transcript API

> Call the YouTube transcript API to get id, url, language, is auto generated, duration seconds and text, as JSON or markdown. 3 credits.

* **Endpoint:** `youtube.transcript`
* **Returns:** `data` has `id`, `url`, `language`, `isAutoGenerated`, `durationSeconds`, `text`, `segments`.
* **Cost:** 3 credits. Failed calls cost nothing.
* **Paging:** No.

Pass a video id or URL in `video`. Set `includeTimestamps` to get each line with its time.

## Example

<CodeGroup>
  ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.youtube.transcript({ video: "dQw4w9WgXcQ" });
  console.log(result.data.text);
  ```

  ```python Python icon="python" theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.youtube.transcript(video="dQw4w9WgXcQ")
  print(result["data"]["text"])
  ```

  ```bash cURL icon="terminal" theme={null}
  curl -X POST https://api.stophy.dev/v1/youtube/transcript \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"video":"dQw4w9WgXcQ"}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy youtube transcript dQw4w9WgXcQ
  ```
</CodeGroup>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/youtube/transcript
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Send Accept: text/markdown to get markdown instead of JSON.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    x-credits is what one call costs. When x-per-items is set, a call costs
    x-credits for every x-per-items items it returns, and at least x-credits.


    When a response has a cursor, send it back with the same input to get the
    next page.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/youtube/transcript:
    post:
      summary: Get a video's transcript, with optional timestamps
      description: Costs 3 credits.
      operationId: youtubeTranscript
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                video:
                  type: string
                language:
                  type: string
                  pattern: ^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$
                  description: BCP 47 language tag, e.g. en or pt-BR. Any case is accepted.
                includeTimestamps:
                  default: false
                  type: boolean
              required:
                - video
              additionalProperties: false
            example:
              video: dQw4w9WgXcQ
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      url:
                        type: string
                        format: uri
                      language:
                        type: string
                      isAutoGenerated:
                        type: boolean
                      durationSeconds:
                        type: number
                      text:
                        type: string
                      segments:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            startSeconds:
                              type: number
                            endSeconds:
                              type: number
                            text:
                              type: string
                          required:
                            - startSeconds
                            - endSeconds
                    required:
                      - url
                      - isAutoGenerated
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
            text/markdown:
              schema:
                type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````