Ditto Audio

Ditto Audio Sync/data API

Reader cloud sync — bookmarks, annotations, models, audio

GitHub OpenAPI

Operations 12

GET /v1/sync/bookmarks Sync data controller list bookmarks #
PUT /v1/sync/bookmarks Add/update a bookmark (upsert by clientId) #
DELETE /v1/sync/bookmarks/{clientId} Sync data controller delete bookmark #
GET /v1/sync/annotations Sync data controller list annotations #
PUT /v1/sync/annotations Add/update a highlight/note/clipping (upsert by clientId) #
DELETE /v1/sync/annotations/{clientId} Sync data controller delete annotation #
GET /v1/sync/models Sync data controller list models #
PUT /v1/sync/models Record/update a used voice model (upsert by modelId) #
PUT /v1/sync/audio Upsert rendered-audio chunk metadata #
POST /v1/sync/audio/{audioId}/presign Presigned PUT to back up the audio bytes #
POST /v1/sync/audio/{audioId}/confirm Sync data controller confirm audio #
GET /v1/sync/audio/{audioId}/download Sync data controller download audio #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ditto-audio/openapi/ditto-audio-sync-data-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ditto-audio/json-schema/ditto-audio-speech-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/ditto-audio/json-schema/ditto-audio-create-audio-batch-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/ditto-audio/json-schema/ditto-audio-speech-batch-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/ditto-audio/json-schema/ditto-audio-create-voice-model-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/ditto-audio/json-schema/ditto-audio-update-voice-model-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/ditto-audio/json-schema/ditto-audio-create-custom-voice-dto-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ditto-audio:ditto-audio-sync-data-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ditto-audio-sync-data-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ditto.audio Sync/data 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: sync/data
  description: Reader cloud sync — bookmarks, annotations, models, audio
paths:
  /v1/sync/bookmarks:
    get:
      operationId: SyncDataController_listBookmarks
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller list bookmarks
      x-summary-source: derived
    put:
      operationId: SyncDataController_upsertBookmark
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertBookmarkDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Add/update a bookmark (upsert by clientId)
      tags:
      - sync/data
  /v1/sync/bookmarks/{clientId}:
    delete:
      operationId: SyncDataController_deleteBookmark
      parameters:
      - name: clientId
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller delete bookmark
      x-summary-source: derived
  /v1/sync/annotations:
    get:
      operationId: SyncDataController_listAnnotations
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller list annotations
      x-summary-source: derived
    put:
      operationId: SyncDataController_upsertAnnotation
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertAnnotationDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Add/update a highlight/note/clipping (upsert by clientId)
      tags:
      - sync/data
  /v1/sync/annotations/{clientId}:
    delete:
      operationId: SyncDataController_deleteAnnotation
      parameters:
      - name: clientId
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller delete annotation
      x-summary-source: derived
  /v1/sync/models:
    get:
      operationId: SyncDataController_listModels
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller list models
      x-summary-source: derived
    put:
      operationId: SyncDataController_upsertModel
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertModelRefDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Record/update a used voice model (upsert by modelId)
      tags:
      - sync/data
  /v1/sync/audio:
    put:
      operationId: SyncDataController_upsertAudio
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertAudioChunkDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Upsert rendered-audio chunk metadata
      tags:
      - sync/data
  /v1/sync/audio/{audioId}/presign:
    post:
      operationId: SyncDataController_presignAudio
      parameters:
      - name: audioId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresignBlobDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Presigned PUT to back up the audio bytes
      tags:
      - sync/data
  /v1/sync/audio/{audioId}/confirm:
    post:
      operationId: SyncDataController_confirmAudio
      parameters:
      - name: audioId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmBlobDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller confirm audio
      x-summary-source: derived
  /v1/sync/audio/{audioId}/download:
    get:
      operationId: SyncDataController_downloadAudio
      parameters:
      - name: audioId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - sync/data
      summary: Sync data controller download audio
      x-summary-source: derived
components:
  schemas:
    UpsertModelRefDto:
      type: object
      properties:
        modelId:
          type: string
        category:
          type: string
        isDefault:
          type: boolean
        lastUsedAtMs:
          type: number
        deleted:
          type: boolean
      required:
      - modelId
    PresignBlobDto:
      type: object
      properties:
        fileName:
          type: string
          example: mybook.epub
        contentType:
          type: string
        contentHash:
          type: string
      required:
      - fileName
    UpsertAudioChunkDto:
      type: object
      properties:
        bookId:
          type: string
        chapterIndex:
          type: number
        paragraphIndex:
          type: number
        voiceId:
          type: string
        speed:
          type: number
          default: 1
        sampleRate:
          type: number
          default: 24000
        sentenceSamples:
          type: array
          items:
            type: number
        contentHash:
          type: string
        deleted:
          type: boolean
      required:
      - bookId
      - chapterIndex
      - paragraphIndex
      - voiceId
    UpsertBookmarkDto:
      type: object
      properties:
        clientId:
          type: string
          description: client bookmark id
        bookId:
          type: string
        chapterIndex:
          type: number
        paragraphIndex:
          type: number
        cfi:
          type: string
        label:
          type: string
        note:
          type: string
        createdAtMs:
          type: number
        deleted:
          type: boolean
      required:
      - clientId
      - bookId
    UpsertAnnotationDto:
      type: object
      properties:
        clientId:
          type: string
          description: client annotation id
        bookId:
          type: string
        kind:
          type: string
          enum:
          - highlight
          - note
          - clipping
        chapterIndex:
          type: number
        paragraphIndex:
          type: number
        cfi:
          type: string
        selectedText:
          type: string
        color:
          type: string
          example: yellow
        noteContent:
          type: string
        chapterTitle:
          type: string
        createdAtMs:
          type: number
        deleted:
          type: boolean
      required:
      - clientId
      - bookId
      - kind
    ConfirmBlobDto:
      type: object
      properties:
        s3Key:
          type: string
        contentHash:
          type: string
      required:
      - s3Key
  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.