APIs.io Engineering Platform Stream Subtitles/Captions API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Stream Subtitles/Captions API
  version: 4.0.0
tags:
- name: Stream Subtitles/Captions
paths:
  /accounts/{account_id}/stream/{identifier}/captions:
    get:
      description: Lists the available captions or subtitles for a specific video.
      operationId: stream-subtitles/-captions-list-captions-or-subtitles
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List captions or subtitles response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_collection'
          description: List captions or subtitles response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List captions or subtitles
      tags:
      - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/captions/{language}:
    delete:
      description: Removes the captions or subtitles from a video.
      operationId: stream-subtitles/-captions-delete-captions-or-subtitles
      parameters:
      - in: path
        name: language
        required: true
        schema:
          $ref: '#/components/schemas/stream_language'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete captions or subtitles response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/stream_api-response-common'
                - properties:
                    result:
                      example: ''
                      type: string
          description: Delete captions or subtitles response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete captions or subtitles
      tags:
      - Stream Subtitles/Captions
    get:
      description: Lists the captions or subtitles for provided language.
      operationId: stream-subtitles/-captions-get-caption-or-subtitle-for-language
      parameters:
      - in: path
        name: language
        required: true
        schema:
          $ref: '#/components/schemas/stream_language'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List captions or subtitles response for a provided language
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_single'
          description: List captions or subtitles response for a provided language
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List captions or subtitles for a provided language
      tags:
      - Stream Subtitles/Captions
    put:
      description: Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.
      operationId: stream-subtitles/-captions-upload-captions-or-subtitles
      parameters:
      - in: path
        name: language
        required: true
        schema:
          $ref: '#/components/schemas/stream_language'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/stream_caption_basic_upload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Upload captions or subtitles response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_single'
          description: Upload captions or subtitles response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Upload captions or subtitles
      tags:
      - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/captions/{language}/generate:
    post:
      description: Generate captions or subtitles for provided language via AI.
      operationId: stream-subtitles/-captions-generate-caption-or-subtitle-for-language
      parameters:
      - in: path
        name: language
        required: true
        schema:
          $ref: '#/components/schemas/stream_language'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Generate captions or subtitles response for a provided language
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_single'
          description: Generate captions or subtitles response for a provided language
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Generate captions or subtitles for a provided language via AI
      tags:
      - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/captions/{language}/vtt:
    get:
      description: Return WebVTT captions for a provided language.
      operationId: stream-subtitles/-captions-get-vtt-caption-or-subtitle
      parameters:
      - in: path
        name: language
        required: true
        schema:
          $ref: '#/components/schemas/stream_language'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Return WebVTT caption or subtitle response failure
        '200':
          content:
            text/vtt:
              schema:
                example: "'WEBVTT\n 00:00:00.000 --> 00:00:02.480\n This is example response'\n"
                type: string
          description: Return WebVTT caption or subtitle response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Return WebVTT captions for a provided language
      tags:
      - Stream Subtitles/Captions
components:
  schemas:
    stream_identifier:
      description: A Cloudflare-generated unique identifier for a media item.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/stream_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/stream_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    stream_language_response_collection:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/stream_captions'
            type: array
    stream_caption_status:
      description: The status of a generated caption.
      enum:
      - ready
      - inprogress
      - error
      type: string
    stream_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    stream_api-response-single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      type: object
    stream_captions:
      properties:
        generated:
          $ref: '#/components/schemas/stream_generated_caption'
        label:
          $ref: '#/components/schemas/stream_label'
        language:
          $ref: '#/components/schemas/stream_language'
        status:
          $ref: '#/components/schemas/stream_caption_status'
      type: object
    stream_label:
      description: The language label displayed in the native language to users.
      example: Türkçe
      type: string
    stream_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/stream_messages'
        messages:
          $ref: '#/components/schemas/stream_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    stream_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    stream_caption_basic_upload:
      properties:
        file:
          description: The WebVTT file containing the caption or subtitle content.
          example: '@/Users/kyle/Desktop/tr.vtt'
          type: string
      required:
      - file
      type: object
    stream_language:
      description: The language tag in BCP 47 format.
      example: tr
      type: string
    stream_language_response_single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/stream_captions'
    stream_generated_caption:
      description: Whether the caption was generated via AI.
      example: true
      type: boolean
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey