Ditto Audio Training API

openapi: 3.2.0
info:
  title: ditto.audio Training 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: Training
  description: Voice-model training / cloning jobs
paths:
  /v1/training/entitlement:
    get:
      operationId: TrainingController_entitlement
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Cloud-training entitlement + live usage for the current user
      tags:
      - Training
  /v1/training/jobs:
    post:
      description: 'Upload each reference clip with HTTP PUT to its presigned URL, then call confirm-uploads. Gated: paid plan (402), per-tier concurrent job limit (429), and the kind being trainable right now (409 TRAINER_UNAVAILABLE; see `trainers` in GET /training/entitlement).'
      operationId: TrainingController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTrainingJobDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Create a training job (draft) + presigned dataset upload URLs
      tags:
      - Training
    get:
      operationId: TrainingController_list
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List my training jobs (newest first)
      tags:
      - Training
  /v1/training/jobs/{id}/confirm-uploads:
    post:
      operationId: TrainingController_confirm
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Verify the dataset landed in storage and queue the job
      tags:
      - Training
  /v1/training/jobs/{id}/refresh-uploads:
    post:
      description: Only for a job still in draft. The URLs replace the ones from create.
      operationId: TrainingController_refreshUploads
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Fresh upload URLs for a draft whose upload was interrupted
      tags:
      - Training
  /v1/training/jobs/{id}:
    get:
      operationId: TrainingController_get
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Job detail + newest task rollup
      tags:
      - Training
    delete:
      operationId: TrainingController_remove
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: 'Delete a terminal job: its recordings and discarded outputs are removed; a…'
      tags:
      - Training
  /v1/training/jobs/{id}/cancel:
    post:
      operationId: TrainingController_cancel
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Cancel a job (idempotent; discards any in-flight result)
      tags:
      - Training
  /v1/training/jobs/{id}/artifacts:
    get:
      operationId: TrainingController_artifacts
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Presigned downloads of the trained voice's files (succeeded only; 410 once the…
      tags:
      - Training
  /v1/training/jobs/{id}/progress:
    post:
      description: Refreshes the running task lease. Replies {ok:false, stale:true} when the task is no longer running so the executor stops a reclaimed/canceled run.
      operationId: TrainingNodeController_progress
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProgressCallbackDto'
      responses:
        '200':
          description: ''
      summary: '[executor] Progress callback — also the lease heartbeat'
      tags:
      - Training
  /v1/training/jobs/{id}/complete:
    post:
      description: 'On success the stored artifacts are verified (present, the right size, the reported hash) and the voice is registered in the same transaction that marks the job succeeded. Idempotent: the executor repeats the report until it is answered. {ok:false, stale:true} when the attempt is no longer the running one (its result is discarded).'
      operationId: TrainingNodeController_complete
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteCallbackDto'
      responses:
        '200':
          description: ''
      summary: '[executor] The run ended: the artifact manifest, or the failure'
      tags:
      - Training
components:
  schemas:
    CompleteCallbackDto:
      type: object
      properties: {}
    ProgressCallbackDto:
      type: object
      properties: {}
    CreateTrainingJobDto:
      type: object
      properties: {}
  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.