Ditto Audio

Ditto Audio Pre Render API

Distributed render offload — nodes, jobs, assignments & live presence

GitHub OpenAPI

Operations 25

POST /v1/pre-render/nodes/register Register/refresh this device as a render node #
POST /v1/pre-render/nodes/{nodeId}/heartbeat Keep a node online + report progress/capabilities #
GET /v1/pre-render/nodes Your render nodes (devices + the premium cloud node) #
DELETE /v1/pre-render/nodes/{nodeId} Remove a device node #
GET /v1/pre-render/entitlement Whether your tier may use the premium cloud node #
POST /v1/pre-render/jobs Create a pre-render job for a book #
GET /v1/pre-render/jobs List your pre-render jobs #
GET /v1/pre-render/jobs/{jobId} Poll a job — status + progress #
POST /v1/pre-render/jobs/{jobId}/cancel Cancel a job (stales all unfinished chunks) #
POST /v1/pre-render/jobs/{jobId}/allocate Run the queue scheduler + return this book's chunk plan #
PUT /v1/pre-render/queue Reorder the book queue (front → back); promotes the new front #
PUT /v1/pre-render/jobs/{jobId}/pins Pin chapters to specific nodes, then re-allocate #
PUT /v1/pre-render/jobs/{jobId}/excluded Leave devices out of this render (or include them again), then re-allocate #
GET /v1/pre-render/jobs/{jobId}/assignments List a job's chunk assignments (optionally for one node) #
GET /v1/pre-render/work A node's claimable chunks across ALL active books (priority order) #
POST /v1/pre-render/assignments/{assignmentId}/claim Claim a chunk for your node + get presigned mp3 upload URLs #
POST /v1/pre-render/assignments/{assignmentId}/chunk-upload-url Ask-before-upload for the assignment's canonical WAV chunk (coords derived… #
POST /v1/pre-render/assignments/{assignmentId}/chunk-confirm Register the uploaded chunk blob + grant this account its pointer #
POST /v1/pre-render/assignments/{assignmentId}/confirm Close a rendered assignment (blob confirm: no paragraphs; legacy: per-paragraph… #
POST /v1/pre-render/assignments/{assignmentId}/release Hand back a claimed chunk you could not deliver (one attempt; re-placed at once) #
GET /v1/pre-render/sync Delta of your nodes/jobs/assignments since a cursor #
POST /v1/pre-render/presence Report what this device is streaming/receiving right now (?map=1 answers with… #
GET /v1/pre-render/presence Live map: who streams/receives which book + last-active reader #
DELETE /v1/pre-render/presence/{deviceId} A device leaving (a closing tab): drop its live entry and reader claims at once #
POST /v1/pre-render/presence/config Set this device's mesh participation config #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ditto-audio/openapi/ditto-audio-pre-render-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-pre-render-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-pre-render-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ditto.audio Pre Render 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: pre-render
  description: Distributed render offload — nodes, jobs, assignments & live presence
paths:
  /v1/pre-render/nodes/register:
    post:
      operationId: PreRenderController_registerNode
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterNodeDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Register/refresh this device as a render node
      tags:
      - pre-render
  /v1/pre-render/nodes/{nodeId}/heartbeat:
    post:
      operationId: PreRenderController_heartbeatNode
      parameters:
      - name: nodeId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HeartbeatNodeDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Keep a node online + report progress/capabilities
      tags:
      - pre-render
  /v1/pre-render/nodes:
    get:
      operationId: PreRenderController_listNodes
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Your render nodes (devices + the premium cloud node)
      tags:
      - pre-render
  /v1/pre-render/nodes/{nodeId}:
    delete:
      operationId: PreRenderController_deleteNode
      parameters:
      - name: nodeId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Remove a device node
      tags:
      - pre-render
  /v1/pre-render/entitlement:
    get:
      operationId: PreRenderController_entitlement
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Whether your tier may use the premium cloud node
      tags:
      - pre-render
  /v1/pre-render/jobs:
    post:
      operationId: PreRenderController_createJob
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Create a pre-render job for a book
      tags:
      - pre-render
    get:
      operationId: PreRenderController_listJobs
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List your pre-render jobs
      tags:
      - pre-render
  /v1/pre-render/jobs/{jobId}:
    get:
      operationId: PreRenderController_getJob
      parameters:
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Poll a job — status + progress
      tags:
      - pre-render
  /v1/pre-render/jobs/{jobId}/cancel:
    post:
      operationId: PreRenderController_cancelJob
      parameters:
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Cancel a job (stales all unfinished chunks)
      tags:
      - pre-render
  /v1/pre-render/jobs/{jobId}/allocate:
    post:
      operationId: PreRenderController_allocate
      parameters:
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Run the queue scheduler + return this book's chunk plan
      tags:
      - pre-render
  /v1/pre-render/queue:
    put:
      operationId: PreRenderController_reorderQueue
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReorderQueueDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Reorder the book queue (front → back); promotes the new front
      tags:
      - pre-render
  /v1/pre-render/jobs/{jobId}/pins:
    put:
      operationId: PreRenderController_setPins
      parameters:
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetPinsDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Pin chapters to specific nodes, then re-allocate
      tags:
      - pre-render
  /v1/pre-render/jobs/{jobId}/excluded:
    put:
      operationId: PreRenderController_setExcluded
      parameters:
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetExcludedDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Leave devices out of this render (or include them again), then re-allocate
      tags:
      - pre-render
  /v1/pre-render/jobs/{jobId}/assignments:
    get:
      operationId: PreRenderController_assignments
      parameters:
      - name: jobId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List a job's chunk assignments (optionally for one node)
      tags:
      - pre-render
  /v1/pre-render/work:
    get:
      operationId: PreRenderController_work
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: A node's claimable chunks across ALL active books (priority order)
      tags:
      - pre-render
  /v1/pre-render/assignments/{assignmentId}/claim:
    post:
      operationId: PreRenderController_claim
      parameters:
      - name: assignmentId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimAssignmentDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Claim a chunk for your node + get presigned mp3 upload URLs
      tags:
      - pre-render
  /v1/pre-render/assignments/{assignmentId}/chunk-upload-url:
    post:
      operationId: PreRenderController_chunkUploadUrl
      parameters:
      - name: assignmentId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudChunkUploadUrlDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Ask-before-upload for the assignment's canonical WAV chunk (coords derived…
      tags:
      - pre-render
  /v1/pre-render/assignments/{assignmentId}/chunk-confirm:
    post:
      operationId: PreRenderController_chunkConfirm
      parameters:
      - name: assignmentId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudChunkConfirmDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Register the uploaded chunk blob + grant this account its pointer
      tags:
      - pre-render
  /v1/pre-render/assignments/{assignmentId}/confirm:
    post:
      operationId: PreRenderController_confirm
      parameters:
      - name: assignmentId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmAssignmentDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: 'Close a rendered assignment (blob confirm: no paragraphs; legacy: per-paragraph…'
      tags:
      - pre-render
  /v1/pre-render/assignments/{assignmentId}/release:
    post:
      operationId: PreRenderController_release
      parameters:
      - name: assignmentId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseAssignmentDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Hand back a claimed chunk you could not deliver (one attempt; re-placed at once)
      tags:
      - pre-render
  /v1/pre-render/sync:
    get:
      operationId: PreRenderController_sync
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Delta of your nodes/jobs/assignments since a cursor
      tags:
      - pre-render
  /v1/pre-render/presence:
    post:
      operationId: PreRenderController_reportPresence
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportPresenceDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Report what this device is streaming/receiving right now (?map=1 answers with…
      tags:
      - pre-render
    get:
      operationId: PreRenderController_getPresence
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: 'Live map: who streams/receives which book + last-active reader'
      tags:
      - pre-render
  /v1/pre-render/presence/{deviceId}:
    delete:
      operationId: PreRenderController_leavePresence
      parameters:
      - name: deviceId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: 'A device leaving (a closing tab): drop its live entry and reader claims at once'
      tags:
      - pre-render
  /v1/pre-render/presence/config:
    post:
      operationId: PreRenderController_setPresenceConfig
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresenceConfigDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Set this device's mesh participation config
      tags:
      - pre-render
components:
  schemas:
    HeartbeatNodeDto:
      type: object
      properties: {}
    ConfirmAssignmentDto:
      type: object
      properties: {}
    ReportPresenceDto:
      type: object
      properties: {}
    CreateJobDto:
      type: object
      properties: {}
    SetExcludedDto:
      type: object
      properties: {}
    CloudChunkUploadUrlDto:
      type: object
      properties: {}
    ClaimAssignmentDto:
      type: object
      properties: {}
    RegisterNodeDto:
      type: object
      properties: {}
    PresenceConfigDto:
      type: object
      properties: {}
    CloudChunkConfirmDto:
      type: object
      properties: {}
    SetPinsDto:
      type: object
      properties: {}
    ReorderQueueDto:
      type: object
      properties: {}
    ReleaseAssignmentDto:
      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.