{
  "$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"
}