swagger: '2.0'
info:
  title: Panopto Public Accessibility Streams API
  description: The public API for Panopto. OpenID & OAuth information can be found at Panopto/oauth2/.well-known/openid-configuration
  version: '1'
host: <PanoptoServerURL>(i.e. example.hosted.panopto.com)
basePath: /Panopto
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Streams
  description: Stream API
paths:
  /api/v1/streams/{id}/captions:
    post:
      tags:
      - Streams
      summary: Upload a caption file (in SRT or VTT format) to this stream
      description: Content should be sent as 'multipart/form-data', with the caption file attached as part of the multi-part data. This endpoint is used to upload captions for a single stream, and timestamps should be based on the un-edited stream. Please verify that the timestamps in your caption file are correlated to the unedited time for this stream.
      operationId: Streams_UploadCaptionsToStream
      parameters:
      - type: string
        name: id
        in: path
        required: true
        format: guid
        x-nullable: false
      - name: language
        in: formData
        schema:
          title: ContentLanguage
          type: string
          description: Language of content such as sessions, streams, or captions.
          x-enumNames:
          - English_USA
          - English_GBR
          - Spanish_MEX
          - Spanish_ESP
          - German
          - French
          - Dutch
          - Thai
          - Chinese_Simplified
          - Chinese_Traditional
          - Korean
          - Japanese
          - Russian
          - Portuguese
          - Polish
          - English_AUS
          - Danish
          - Finnish
          - Hungarian
          - Norwegian
          - Swedish
          - Italian
          - Welsh
          - Catalan
          - Galician
          - Basque
          - Arabic
          - Hindi
          - French_CAN
          - Hebrew
          - Vietnamese
          enum:
          - English_USA
          - English_GBR
          - Spanish_MEX
          - Spanish_ESP
          - German
          - French
          - Dutch
          - Thai
          - Chinese_Simplified
          - Chinese_Traditional
          - Korean
          - Japanese
          - Russian
          - Portuguese
          - Polish
          - English_AUS
          - Danish
          - Finnish
          - Hungarian
          - Norwegian
          - Swedish
          - Italian
          - Welsh
          - Catalan
          - Galician
          - Basque
          - Arabic
          - Hindi
          - French_CAN
          - Hebrew
          - Vietnamese
        enum:
        - English_USA
        - English_GBR
        - Spanish_MEX
        - Spanish_ESP
        - German
        - French
        - Dutch
        - Thai
        - Chinese_Simplified
        - Chinese_Traditional
        - Korean
        - Japanese
        - Russian
        - Portuguese
        - Polish
        - English_AUS
        - Danish
        - Finnish
        - Hungarian
        - Norwegian
        - Swedish
        - Italian
        - Welsh
        - Catalan
        - Galician
        - Basque
        - Arabic
        - Hindi
        - French_CAN
        - Hebrew
        - Vietnamese
      responses:
        '200':
          description: ''
        '400':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/APIError'
        '403':
          description: User does not have permission to access this function
        '401':
          description: The user is not authorized to perform the requested action
        '404':
          x-nullable: false
          description: The requested stream was not found
          schema:
            $ref: '#/definitions/APIError'
definitions:
  APIErrorInternal:
    type: object
    required:
    - Success
    properties:
      ErrorCode:
        type: string
        description: Internal error code
      Message:
        type: string
      Success:
        type: boolean
        description: If true the call succeed and this is a partial failure (or warning). If false the call failed overall
      ErrorSource:
        type: string
        description: Unique identifier of what caused this error
  APIError:
    type: object
    properties:
      Error:
        description: Error result returned if an error occurs in Panopto, otherwise null or missing
        $ref: '#/definitions/APIErrorInternal'
x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))