Ditto Audio

Ditto Audio Sync API

Reader cloud sync — settings, push/pull delta

GitHub OpenAPI

Operations 6

GET /v1/sync/state Sync toggle + settings + per-domain counts #
GET /v1/sync/settings Get the settings blob + sync toggle #
PUT /v1/sync/settings Update settings blob and/or the sync toggle #
GET /v1/sync/pull Everything changed since ?since= (tombstones included) #
POST /v1/sync/push Batch upsert across all domains #
POST /v1/sync/inventory Report what you already have; get back only the missing delta #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ditto-audio/openapi/ditto-audio-sync-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-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-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ditto.audio Sync 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
  description: Reader cloud sync — settings, push/pull delta
paths:
  /v1/sync/state:
    get:
      operationId: SyncController_state
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Sync toggle + settings + per-domain counts
      tags:
      - Sync
  /v1/sync/settings:
    get:
      operationId: SyncController_getSettings
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get the settings blob + sync toggle
      tags:
      - Sync
    put:
      operationId: SyncController_updateSettings
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSettingsDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Update settings blob and/or the sync toggle
      tags:
      - Sync
  /v1/sync/pull:
    get:
      operationId: SyncController_pull
      parameters:
      - name: since
        required: false
        in: query
        description: ISO timestamp; only return rows changed after it
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Everything changed since ?since= (tombstones included)
      tags:
      - Sync
  /v1/sync/push:
    post:
      operationId: SyncController_push
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncPushDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Batch upsert across all domains
      tags:
      - Sync
  /v1/sync/inventory:
    post:
      operationId: SyncController_inventory
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncInventoryDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Report what you already have; get back only the missing delta
      tags:
      - Sync
components:
  schemas:
    SyncInventoryDto:
      type: object
      properties:
        books:
          type: array
          items:
            $ref: '#/components/schemas/InventoryBookDto'
        models:
          description: voice-model ids already downloaded
          maxItems: 1000
          type: array
          items:
            type: string
        audioChunks:
          description: 'rendered-audio keys already cached: "bookId|chapter|paragraph|voiceId|speed"'
          type: array
          items:
            type: string
    UpsertModelRefDto:
      type: object
      properties:
        modelId:
          type: string
        category:
          type: string
        isDefault:
          type: boolean
        lastUsedAtMs:
          type: number
        deleted:
          type: boolean
      required:
      - modelId
    SyncPushDto:
      type: object
      properties:
        books:
          type: array
          items:
            $ref: '#/components/schemas/UpsertBookDto'
        progress:
          type: array
          items:
            $ref: '#/components/schemas/UpsertProgressDto'
        bookmarks:
          type: array
          items:
            $ref: '#/components/schemas/UpsertBookmarkDto'
        annotations:
          type: array
          items:
            $ref: '#/components/schemas/UpsertAnnotationDto'
        models:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/UpsertModelRefDto'
        audioChunks:
          type: array
          items:
            $ref: '#/components/schemas/UpsertAudioChunkDto'
        settings:
          $ref: '#/components/schemas/UpdateSettingsDto'
    UpsertBookDto:
      type: object
      properties:
        bookId:
          type: string
          description: client book id (stable across devices)
        title:
          type: string
        author:
          type: string
        format:
          type: string
          example: epub
        chapterCount:
          type: number
        contentHash:
          type: string
          description: sha-256 of the book file
        coverImageUrl:
          type: string
        addedAtMs:
          type: number
          description: client add time, ms epoch
        deleted:
          type: boolean
          description: tombstone — remove from cloud library
      required:
      - bookId
      - title
    UpdateSettingsDto:
      type: object
      properties:
        syncEnabled:
          type: boolean
        settings:
          type: object
          description: opaque client settings blob
    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
    UpsertProgressDto:
      type: object
      properties:
        bookId:
          type: string
        chapterIndex:
          type: number
        paragraphIndex:
          type: number
        cfi:
          type: string
          description: epub.js CFI (web reader)
        percentComplete:
          type: number
          description: 0..1
        totalReadingTimeMs:
          type: number
        lastReadAtMs:
          type: number
    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
    InventoryBookDto:
      type: object
      properties:
        bookId:
          type: string
        contentHash:
          type: string
          description: sha256 of the local EPUB bytes
      required:
      - bookId
  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.