Auphonic Info API

openapi: 3.2.0
info:
  title: Auphonic Info API
  description: 'The Auphonic REST API allows you to integrate audio post production services

    and algorithms into your scripts, external workflows and third-party applications.'
  contact:
    email: support@auphonic.com
    url: https://auphonic.com
servers:
- url: https://auphonic.com
  description: Auphonic Production Server
security:
- bearerAuth: []
- basicAuth: []
- oauth2: []
tags:
- name: Info
  description: 'Query available formats, algorithms and service types.


    See the Info API documentation for details.'
paths:
  /api/info.json:
    get:
      tags:
      - Info
      summary: Get all API info
      description: 'Returns all info endpoints in a single response: output file formats,

        service types, audio algorithms, and production status codes.


        See the Info API documentation for details.'
      operationId: getAllInfo
      security:
      - bearerAuth: []
      - basicAuth: []
      - oauth2: []
      - {}
      responses:
        '200':
          description: All API info
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApiResponseEnvelope'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        output_files:
                          type: object
                          additionalProperties:
                            $ref: '#/components/schemas/OutputFormatInfo'
                        service_types:
                          type: object
                          additionalProperties:
                            $ref: '#/components/schemas/ServiceTypeInfo'
                        algorithms:
                          type: object
                          additionalProperties:
                            $ref: '#/components/schemas/AlgorithmInfo'
                        production_status:
                          type: object
                          description: 'Map of status code to status string. Status codes:

                            0=File Upload, 1=Waiting, 2=Error, 3=Done, 4=Audio Processing,

                            5=Audio Encoding, 6=Outgoing File Transfer, 7=Audio Mono Mixdown,

                            8=Split Audio On Chapter Marks, 9=Incomplete, 10=Production Not Started Yet,

                            11=Production Outdated, 12=Incoming File Transfer, 13=Stopping the Production,

                            14=Speech Recognition, 15=Production Changed

                            '
                          additionalProperties:
                            type: string
  /api/info/{subject}.json:
    get:
      tags:
      - Info
      summary: Get specific API info
      description: 'Returns info for a specific subject: `output_files`, `service_types`,

        `algorithms`, or `production_status`.


        See the Info API documentation for details.'
      operationId: getInfo
      security:
      - bearerAuth: []
      - basicAuth: []
      - oauth2: []
      - {}
      parameters:
      - name: subject
        in: path
        required: true
        description: The info topic to query
        schema:
          type: string
          enum:
          - output_files
          - service_types
          - algorithms
          - production_status
      responses:
        '200':
          description: Info for the requested subject
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApiResponseEnvelope'
                - type: object
                  properties:
                    data:
                      type: object
components:
  schemas:
    ApiResponseEnvelope:
      type: object
      properties:
        status_code:
          type: integer
          description: HTTP status code
          example: 200
        error_code:
          type:
          - string
          - 'null'
          description: Error code identifier, null on success
        error_message:
          type: string
          description: Human-readable error message, empty on success
          example: ''
        form_errors:
          type: object
          description: Field-level validation errors
          additionalProperties:
            type: array
            items:
              type: string
        data:
          description: Response payload (varies per endpoint)
      required:
      - status_code
      - error_code
      - error_message
      - form_errors
      - data
    OutputFormatInfo:
      type: object
      properties:
        display_name:
          type: string
          example: MP3
        type:
          type: string
          description: 'Format type: lossy, lossless, video, or description'
          enum:
          - lossy
          - lossless
          - video
          - description
        bitrates:
          type: array
          items:
            type: string
          description: Available bitrates (lossy formats only)
        bitrate_strings:
          type: array
          items:
            type: string
          description: Human-readable bitrate descriptions
        default_bitrate:
          type: string
          description: Default bitrate (lossy formats only)
        endings:
          type: array
          items:
            type: string
          description: File extensions
    ServiceTypeInfo:
      type: object
      properties:
        display_name:
          type: string
        parameters:
          type:
          - object
          - 'null'
          description: Available parameters for this service type
          additionalProperties:
            type: object
            properties:
              display_name:
                type: string
              type:
                type: string
                enum:
                - checkbox
                - select
              default_value: {}
              options:
                type: array
                items:
                  type: object
                  properties:
                    display_name:
                      type: string
                    value: {}
    AlgorithmInfo:
      type: object
      properties:
        display_name:
          type: string
        type:
          type: string
          enum:
          - checkbox
          - select
        default_value: {}
        description:
          type: string
        belongs_to:
          type: string
          description: Parent algorithm this parameter belongs to
        options:
          type: array
          items:
            type: object
            properties:
              display_name:
                type: string
              value: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API Key or OAuth2 access token. Use header `Authorization: Bearer {token}`

        or query parameter `?bearer_token={token}`.

        '
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with Auphonic username and password.
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for third-party applications.
      flows:
        authorizationCode:
          authorizationUrl: https://auphonic.com/oauth2/authorize/
          tokenUrl: https://auphonic.com/oauth2/token/
          scopes: {}
        password:
          tokenUrl: https://auphonic.com/oauth2/token/
          scopes: {}