Auphonic User API

openapi: 3.2.0
info:
  title: Auphonic User 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: User
  description: 'User account information.


    See the User API documentation for details.'
paths:
  /api/user.json:
    get:
      tags:
      - User
      summary: Get current user account info
      description: 'Returns information and settings of the authenticated user account.


        See the User API documentation for details.'
      operationId: getUser
      responses:
        '200':
          description: User account info
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApiResponseEnvelope'
                - type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/User'
              example:
                status_code: 200
                error_code: null
                error_message: ''
                form_errors: {}
                data:
                  username: podcaster
                  email: podcaster@example.com
                  user_id: abc123def456
                  date_joined: '2023-06-01T12:00:00Z'
                  credits: 4.5
                  onetime_credits: 2.0
                  recurring_credits: 2.5
                  recharge_date: '2025-02-01T00:00:00Z'
                  recharge_recurring_credits: 2.5
                  notification_email: true
                  error_email: true
                  warning_email: true
                  low_credits_email: true
                  low_credits_threshold: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponseEnvelope'
          example:
            status_code: 401
            error_code: null
            error_message: Authentication required
            form_errors: {}
            data: {}
  schemas:
    User:
      type: object
      required:
      - username
      - email
      - user_id
      - date_joined
      - credits
      - onetime_credits
      - recurring_credits
      - is_paying_user
      properties:
        username:
          type: string
        email:
          type: string
          format: email
        user_id:
          type: string
          description: Unique user identifier (stable even when username changes)
        date_joined:
          type: string
          format: date-time
        credits:
          type: number
          description: Total available credits in hours
        onetime_credits:
          type: number
          description: Available one-time credits in hours
        recurring_credits:
          type: number
          description: Available recurring credits in hours
        recharge_date:
          type: string
          format: date-time
          description: Date when recurring credits are recharged
        recharge_recurring_credits:
          type: number
          description: Amount of recurring credits recharged
        notification_email:
          type: boolean
        error_email:
          type: boolean
        warning_email:
          type: boolean
        low_credits_email:
          type: boolean
        low_credits_threshold:
          type: integer
          description: Low credits warning threshold
        is_paying_user:
          type: boolean
          description: True if the user (or their team account owner) has paid for recurring or one-time credits.
    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
  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: {}