Ditto Audio Releases API

openapi: 3.2.0
info:
  title: ditto.audio Releases API
  description: Cloud API behind ditto.audio. The reader (reader.ditto.audio) and the voice studio (studio.ditto.audio) are separate apps sharing this one backend — see /docs/reader and /docs/inference for each app’s public surface. Third-party integrations want /docs/public (rendered for humans at https://ditto.audio/docs).
  version: '1.0'
  contact: {}
servers: []
tags:
- name: Releases
  description: ditto-native desktop app — update channels & release manifests
paths:
  /v1/releases:
    post:
      operationId: DittoReleasesController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReleaseDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Create a new release (draft)
      tags:
      - Releases
    get:
      operationId: DittoReleasesController_list
      parameters:
      - name: productId
        required: true
        in: query
        schema:
          type: string
      - name: channel
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List all releases (optionally filter by product/channel)
      tags:
      - Releases
  /v1/releases/{id}:
    get:
      operationId: DittoReleasesController_findOne
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get a specific release with assets
      tags:
      - Releases
    delete:
      operationId: DittoReleasesController_remove
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - bearer: []
      summary: Delete a release entirely
      tags:
      - Releases
  /v1/releases/{id}/publish:
    patch:
      operationId: DittoReleasesController_publish
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Publish a draft release (makes it available for update checks)
      tags:
      - Releases
  /v1/releases/{id}/yank:
    patch:
      operationId: DittoReleasesController_yank
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Yank a release (hide from update checks)
      tags:
      - Releases
  /v1/releases/{releaseId}/assets:
    post:
      operationId: DittoReleasesController_addAsset
      parameters:
      - name: releaseId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReleaseAssetDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Add a platform asset to a release
      tags:
      - Releases
    get:
      operationId: DittoReleasesController_listAssets
      parameters:
      - name: releaseId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List all assets for a release
      tags:
      - Releases
  /v1/releases/{releaseId}/assets/{assetId}:
    delete:
      operationId: DittoReleasesController_removeAsset
      parameters:
      - name: releaseId
        required: true
        in: path
        schema:
          type: string
      - name: assetId
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - bearer: []
      summary: Remove a platform asset
      tags:
      - Releases
components:
  schemas:
    CreateReleaseDto:
      type: object
      properties:
        version:
          type: string
          example: 1.2.3
          description: Semver version string
        productId:
          type: string
          example: ditto-native
        channel:
          type: string
          enum:
          - stable
          - beta
          - alpha
          default: stable
        releaseNotes:
          type: string
          description: Markdown release notes
        minVersion:
          type: string
          example: 1.0.0
          description: Minimum version required to update directly to this release
        isMandatory:
          type: boolean
          description: Force clients to update (critical fix)
          default: false
      required:
      - version
    CreateReleaseAssetDto:
      type: object
      properties:
        platform:
          type: string
          example: macOS
          description: Target platform
        arch:
          type: string
          example: arm64
          default: universal
        fileName:
          type: string
          example: DittoNative-1.2.3-arm64.dmg
        fileSize:
          type: number
          example: 52428800
          description: File size in bytes
        sha256:
          type: string
          description: SHA-256 hash for integrity
        downloadUrl:
          type: string
          example: https://cdn.ditto.audio/releases/1.2.3/DittoNative-1.2.3-arm64.dmg
          description: Absolute download URL or relative path (combined with assetBaseUrl)
        mimeType:
          type: string
          example: application/octet-stream
        signature:
          type: string
          description: Sparkle/EdDSA signature for macOS auto-update
      required:
      - platform
      - fileName
      - downloadUrl
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: ditto_sk_live_… API key, ditto_oat_… OAuth access token, or a session JWT
      type: http
      description: An API key (`ditto_sk_live_…`, made at https://ditto.audio/account/api-keys) authenticates /v1/audio/* and /v1/reader/*; an OAuth connection's one-hour access token (`ditto_oat_…`) holds the audio:read and audio:speech scopes only. Account routes (/v1/api-keys, /v1/usage, /v1/subscription) take the signed-in session's token (a JWT) only.