openapi: 3.2.0
info:
  title: Vyond API Documentation Video API
  version: 1.1.0
tags:
- name: Video
paths:
  /rest/v1/videos/{videoId}/exports/{conversionId}:
    get:
      operationId: VideoController.getVideoExportDownload
      parameters:
      - in: path
        name: videoId
        required: true
        schema:
          pattern: '[^\/#\?]+?'
          type: string
      - in: path
        name: conversionId
        required: true
        schema:
          pattern: '[^\/#\?]+?'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVideoExportDownloadResBody'
          description: Success. Download URL retrieved
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Bad Request - conversionId must be a positive integer
        '401':
          description: Unauthorized - missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Forbidden - missing required VIDEO_EXPORT scope or access denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Not Found - video or conversion does not exist or is not accessible
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Conflict - export conversion failed or has not completed yet
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Gone - export conversion was canceled
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Too Many Requests - download rate limit reached
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Internal Server Error - unexpected error while retrieving download URL
      summary: Get video export download URL
      tags:
      - Video
      description: Retrieve the download URL for a completed video export
components:
  schemas:
    GetVideoExportDownloadResBody:
      properties:
        id:
          type: integer
          description: The conversion ID of the video export task
        videoId:
          type: string
          description: The video ID
        name:
          type: string
          description: The name of the exported video
        url:
          type: string
          description: Vyond web URL of the video
        revision:
          type: integer
          description: The revision number associated with this conversion
        downloadUrl:
          type: string
          description: The download URL for the video export
        expireAt:
          type: string
          description: The expiration timestamp of the download URL (ISO 8601 format)
      type: object
      required:
      - id
      - videoId
      - name
      - url
      - revision
    ApiErrorResponse:
      properties:
        err:
          type: string
          description: Error code identifying the specific error
        reason:
          type: string
          description: Additional reason describing why the error occurred
        message:
          type: string
          description: Error message, used as an alternative to reason for non-enumerated error messages
        scimType:
          type: string
          description: SCIM error type, present on SCIM 409 Conflict responses (e.g. uniqueness)
        details:
          items:
            $ref: '#/components/schemas/ValidationDetail'
          type: array
          description: Validation error details, present when err is REQUEST_VALIDATION_FAILED
      type: object
      required:
      - err
    ValidationDetail:
      properties:
        property:
          type: string
          description: The property that failed validation
        message:
          items:
            type: string
          type: array
          description: Validation error messages for the property
      type: object
      required:
      - property
      - message
  securitySchemes:
    bearer:
      type: http
      scheme: bearer