APIs.io Engineering Platform Stream Audio Tracks API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Stream Audio Tracks API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Stream Audio Tracks
paths:
  /accounts/{account_id}/stream/{identifier}/audio:
    get:
      description: Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.
      operationId: list-audio-tracks
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Lists additional audio tracks on a video response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_listAudioTrackResponse'
          description: Lists additional audio tracks on a video
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List additional audio tracks on a video
      tags:
      - Stream Audio Tracks
  /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}:
    delete:
      description: Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion.
      operationId: delete-audio-tracks
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: audio_identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_audio_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Deletes additional audio tracks on a video response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Deletes additional audio tracks on a video
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete additional audio tracks on a video
      tags:
      - Stream Audio Tracks
    patch:
      description: Edits additional audio tracks on a video. Editing the default status of an audio track to `true` will mark all other audio tracks on the video default status to `false`.
      operationId: edit-audio-tracks
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      - in: path
        name: audio_identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_audio_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_editAudioTrack'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Edits additional audio tracks on a video response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_addAudioTrackResponse'
          description: Edits additional audio tracks on a video
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Edit additional audio tracks on a video
      tags:
      - Stream Audio Tracks
  /accounts/{account_id}/stream/{identifier}/audio/copy:
    post:
      description: Adds an additional audio track to a video using the provided audio track URL.
      operationId: add-audio-track
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/stream_account_identifier'
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/stream_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_copyAudioTrack'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Add audio tracks to a video response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_addAudioTrackResponse'
          description: Add audio tracks to a video
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Add audio tracks to a video
      tags:
      - Stream Audio Tracks
components:
  schemas:
    stream_listAudioTrackResponse:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/stream_additionalAudio'
            type: array
    stream_copyAudioTrack:
      properties:
        label:
          $ref: '#/components/schemas/stream_audio_label'
        url:
          description: An audio track URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.
          example: https://www.examplestorage.com/audio_file.mp3
          format: uri
          type: string
      required:
      - label
      type: object
    stream_audio_label:
      description: A string to uniquely identify the track amongst other audio track labels for the specified video.
      example: director commentary
      type: string
    stream_editAudioTrack:
      properties:
        default:
          $ref: '#/components/schemas/stream_audio_default'
        label:
          $ref: '#/components/schemas/stream_audio_label'
      type: object
    stream_audio_identifier:
      description: The unique identifier for an additional audio track.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_account_identifier:
      description: The account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    stream_audio_default:
      default: false
      description: Denotes whether the audio track will be played by default in a player.
      type: boolean
    stream_deleted_response:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-single'
      - properties:
          result:
            example: ok
            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_addAudioTrackResponse:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/stream_additionalAudio'
    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
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    stream_audio_state:
      description: Specifies the processing status of the video.
      enum:
      - queued
      - ready
      - 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_additionalAudio:
      properties:
        default:
          $ref: '#/components/schemas/stream_audio_default'
        label:
          $ref: '#/components/schemas/stream_audio_label'
        status:
          $ref: '#/components/schemas/stream_audio_state'
        uid:
          $ref: '#/components/schemas/stream_identifier'
    stream_api-response-single:
      allOf:
      - $ref: '#/components/schemas/stream_api-response-common'
      type: object
    stream_identifier:
      description: A Cloudflare-generated unique identifier for a media item.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true