Audio Delivery Network Organizations API

openapi: 3.2.0
info:
  title: AudioDN Organizations API
  version: 1.0.0
  summary: 'Audio delivery infrastructure: upload, transcode, secure delivery, and playback.'
  description: 'AudioDN provides a REST API and embeddable web components for managing and delivering audio at scale.


    Authentication: bearer token via the `Authorization` header. Use a server-side API key for full access; mint scoped client-side keys (Player or Uploader) for browsers and mobile apps.


    All endpoints are prefixed with `/v1/`.'
  contact:
    name: Audio Delivery Network
    email: support@audiodeliverynetwork.com
    url: https://audiodeliverynetwork.com
  license:
    name: Proprietary
servers:
- url: https://api.audiodelivery.net
  description: Production
security:
- BearerAuth: []
tags:
- name: Organizations
paths:
  /v1/organization/{organization_id}:
    get:
      tags:
      - Organizations
      operationId: getOrganization
      summary: Get organization
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Organization details.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OkEnvelope'
                - type: object
                  properties:
                    organization_id:
                      type: string
                      format: uuid
                    organization:
                      $ref: '#/components/schemas/Organization'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      tags:
      - Organizations
      operationId: updateOrganization
      summary: Update organization
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
      responses:
        '200':
          description: Updated organization.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OkEnvelope'
                - type: object
                  properties:
                    organization_id:
                      type: string
                      format: uuid
                    organization:
                      $ref: '#/components/schemas/Organization'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Organization:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        theme:
          type: array
          items:
            $ref: '#/components/schemas/ImageColor'
        is_theme_overridable:
          type: boolean
        is_cover_overridable:
          type: boolean
        player_color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        player_color_light:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          readOnly: true
          description: Derived read-only variant of player_color adjusted to stay legible on a light background.
        player_color_dark:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          readOnly: true
          description: Derived read-only variant of player_color adjusted to stay legible on a dark background.
        player_subtitle:
          type: string
    ImageColor:
      type: object
      properties:
        hex:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        area:
          type: number
        lightness:
          type: number
        saturation:
          type: number
    Error:
      type: object
      required:
      - ok
      - message
      properties:
        ok:
          type: boolean
          const: false
        message:
          type: string
        api_request_id:
          type: string
          format: uuid
    OkEnvelope:
      type: object
      required:
      - ok
      - api_request_id
      properties:
        ok:
          type: boolean
          const: true
        api_request_id:
          type: string
          format: uuid
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Server-side API key. Use scoped client-side keys for browser and mobile contexts.