Ditto Audio API Keys API

openapi: 3.2.0
info:
  title: ditto.audio API Keys 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: API Keys
  description: Create, rename & revoke the bearer keys used on /v1/audio/*
paths:
  /v1/api-keys:
    get:
      description: Secrets are never returned — each key shows a masked identifier (`ditto_sk_live_7f3a…c91d`) plus its scopes and last-used time.
      operationId: ApiKeysController_list
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List your API keys
      tags:
      - API Keys
    post:
      description: 'The plaintext `secret` is returned ONCE in this response and is never recoverable afterwards — store it immediately. Use it as `Authorization: Bearer ` on /v1/audio/*.'
      operationId: ApiKeysController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyDto'
      responses:
        '201':
          description: The new key + its one-time plaintext secret.
        '400':
          description: Missing name, invalid scopes, or key limit reached.
      security:
      - bearer: []
      summary: Create an API key
      tags:
      - API Keys
  /v1/api-keys/{id}:
    patch:
      operationId: ApiKeysController_rename
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenameApiKeyDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Rename an API key
      tags:
      - API Keys
    delete:
      description: Takes effect immediately. The row is kept (not deleted) so historical usage still resolves to a key name in your analytics.
      operationId: ApiKeysController_revoke
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Revoke an API key
      tags:
      - API Keys
components:
  schemas:
    RenameApiKeyDto:
      type: object
      properties:
        name:
          type: string
          maxLength: 80
      required:
      - name
    CreateApiKeyDto:
      type: object
      properties:
        name:
          type: string
          example: cardiculate-prod
          maxLength: 80
          description: Your label for the key.
        scopes:
          type: array
          description: 'Defaults to every scope. `audio:speech`: synthesize (POST /v1/audio/speech, /speech/batch, /batches and a batch''s /cancel). `audio:read`: GET /v1/audio/voices, /voices/{id}, and reading batches (GET /v1/audio/batches, /{id}, /{id}/items, /{id}/output). `reader:read` / `reader:write`: read or change audiobooks under /v1/reader. GET /v1/audio/languages and /v1/audio/format need no key.'
          items:
            type: string
            enum:
            - audio:speech
            - audio:read
            - reader:read
            - reader:write
        expiresAt:
          type: string
          description: ISO-8601 expiry. Omit for a key that never expires.
      required:
      - name
  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.