audiopod-ai · Schema

BatchNarrationRequest

Artificial IntelligenceAudioPodcastsAudiobookSoftware-as-a-ServiceCompany

Properties

Name Type Description
voice_id object Optional narrator for this run, in place of the book's narrator. With character voices off it voices every selected paragraph. With character voices on (multi_voice) it voices only the narrator's line
chapter_ids object Specific chapters to narrate. Omit to narrate the whole book; an empty list is refused with 400 (code empty_selection).
paragraph_ids object Specific paragraphs to narrate. Omit to narrate the whole book; an empty list is refused with 400 (code empty_selection).
include_completed boolean
include_locked boolean
include_skipped boolean
narration_settings object
multi_voice object Give each character their own voice for this and later narration (saved on the book). Omit to leave the book's setting as it is.
mode string How an edited, previously narrated passage is narrated, where available. 'auto' narrates only the changed sentences when the edit is small enough, and bills only those characters; 'passage' always nar
narration_review_policy object What happens to a passage our narration check cannot confirm after its retry: 'manual' holds it for your approval (the chapter waits on it), 'auto_accept' keeps the best render and counts it under `qu
View JSON Schema on GitHub

JSON Schema

audiopod-ai-batch-narration-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/audiopod-ai/json-schema/audiopod-ai-batch-narration-request-schema.json",
  "title": "BatchNarrationRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/audiopod-ai-audiobook-api-openapi.yml#/components/schemas/BatchNarrationRequest",
  "properties": {
    "voice_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Voice Id",
      "description": "Optional narrator for this run, in place of the book's narrator. With character voices off it voices every selected paragraph. With character voices on (multi_voice) it voices only the narrator's lines: a character with a cast voice, and a paragraph given its own voice, keep theirs. It is a narrator override for this run: it is recorded on the lines it narrates, but not as the author's per-line choice, so with character voices on, cast voices still apply."
    },
    "chapter_ids": {
      "anyOf": [
        {
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Chapter Ids",
      "description": "Specific chapters to narrate. Omit to narrate the whole book; an empty list is refused with 400 (code empty_selection)."
    },
    "paragraph_ids": {
      "anyOf": [
        {
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paragraph Ids",
      "description": "Specific paragraphs to narrate. Omit to narrate the whole book; an empty list is refused with 400 (code empty_selection)."
    },
    "include_completed": {
      "type": "boolean",
      "title": "Include Completed",
      "default": false
    },
    "include_locked": {
      "type": "boolean",
      "title": "Include Locked",
      "default": false
    },
    "include_skipped": {
      "type": "boolean",
      "title": "Include Skipped",
      "default": false
    },
    "narration_settings": {
      "additionalProperties": true,
      "type": "object",
      "title": "Narration Settings"
    },
    "multi_voice": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Multi Voice",
      "description": "Give each character their own voice for this and later narration (saved on the book). Omit to leave the book's setting as it is."
    },
    "mode": {
      "type": "string",
      "enum": [
        "auto",
        "passage"
      ],
      "title": "Mode",
      "description": "How an edited, previously narrated passage is narrated, where available. 'auto' narrates only the changed sentences when the edit is small enough, and bills only those characters; 'passage' always narrates the whole passage.",
      "default": "auto"
    },
    "narration_review_policy": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "manual",
            "auto_accept"
          ]
        },
        {
          "type": "null"
        }
      ],
      "title": "Narration Review Policy",
      "description": "What happens to a passage our narration check cannot confirm after its retry: 'manual' holds it for your approval (the chapter waits on it), 'auto_accept' keeps the best render and counts it under `quality_notes`, so the book never blocks. When sent, it is saved on the book. When omitted on an API-key call and the book has no policy yet, 'auto_accept' is saved; a policy you chose earlier is kept. Automated pipelines should use 'auto_accept'."
    }
  },
  "type": "object"
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/audiopod-ai-batch-narration-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

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