{ "openapi": "3.1.0", "info": { "title": "Voice Creator Pro Desktop API", "description": "HTTP API for voice cloning, voice design, text-to-speech, transcription, audiobooks, dubbing, clips and AI Cut.\n\n## Base URL\n\nThe API runs on your computer at `http://127.0.0.1:8100`. Change the port in Settings or start the app with `--api-port`. Every route starts with `/api/v1/`, except the OpenAI-compatible `POST /v1/audio/speech`. Requests to an unknown path return the app's HTML page, not a 404.\n\n## Authentication\n\nNo key is needed unless you set one in Settings or start the app with `--api-key`. Once set, send it as `X-API-Key: `, `Authorization: Bearer ` or `?api_key=`. `GET /api/v1/health` and `GET /api/v1/system/version` never need a key.\n\n## Quick Start Workflow\n\n1. **Check health**: `GET /api/v1/health`\n2. **Pick a model**: `GET /api/v1/models` lists the models and what each supports\n3. **Generate speech** using one of:\n - `POST /api/v1/tts/generate` to use a built-in speaker voice\n - `POST /api/v1/generation/clone` to clone a voice from reference audio or a saved voice\n - `POST /api/v1/generation/design` to create a voice from a text description\n - `POST /api/v1/conversion/convert` to convert existing speech to another voice\n4. **Get audio**: Pass `?sync=true` to get audio in the response, or poll `GET /api/v1/generation/progress` then `GET /api/v1/generation/result`\n\nThe requested model loads automatically, so the first request after a model switch takes longer. `POST /api/v1/model/load` loads one ahead of time.\n\n## Sync vs Async\n\nAll generation and transcription endpoints accept `?sync=true`. In sync mode, the request blocks until completion and returns the result directly. Generation has a hard 600s cap; transcription uses a 300s inactivity timeout (resets while progress events are flowing) so long audio can finish even if it takes longer than 5 minutes wall-clock. In async mode (default), the request returns immediately and you poll for progress/results.\n\n## Streaming\n\nFor real-time audio streaming, use the `/stream` variants (e.g. `POST /api/v1/generation/clone/stream`). These return a `session_id`. Connect to `GET /api/v1/streaming/{session_id}/audio` to receive a chunked WAV stream as audio is generated. Call `POST /api/v1/streaming/{session_id}/finalize` when done to collect the complete audio as base64.\n\n## Audio Format\n\nAll audio input/output uses base64-encoded WAV unless otherwise noted. The streaming audio endpoint returns raw WAV (PCM 16-bit mono). The output audio format can be changed via `PUT /api/v1/settings/audio-format`.\n\n## Models\n\nMultiple TTS models are available, each with different capabilities.\nQuery `GET /api/v1/models` to list all models, or `GET /api/v1/models/active`\nfor the current model's capabilities.\n\nModels differ in:\n- **Supported modes**: clone, design, and/or TTS (built-in speakers)\n- **Languages**: varies by model and variant\n- **Quality tiers**: each model has its own set of variants\n- **Generation parameters**: model-specific tuning knobs (temperature, exaggeration, etc.)\n\nPass `model_family` on generation requests to target a specific model, or omit it\nto use the currently configured model.\n\n## Validation\n\nAll requests are validated against the target model's capabilities.\nInvalid languages, quality tiers, or generation parameters return\na 400 error listing the valid options.\n\n## Agents\n\n`POST /api/v1/speak` speaks text out loud in a saved voice. `POST /v1/audio/speech` accepts OpenAI text-to-speech requests, so OpenAI clients work by pointing their base URL at this server. An MCP server for AI agents runs at `/mcp`.\n\n## Live avatars\n\nConnect a WebSocket to `/api/v1/talking-head/live` (pass the key as `?api_key=` when one is set) to get a talking face back in real time. Send JSON messages and audio, and receive video frames with their audio.\n\n1. **Start**: `{\"type\": \"start\", \"avatar_id\": \"av_...\"}`, or `\"stock_id\"`, or `\"image_base64\"`. Optional: `\"model\"` (`lite` default, or `pro`), `\"size\"` (512, or 1024 with `pro`), `\"idle\"` (`loop` default, `live` or `none`), `\"pace\"` (`realtime` default, or `fast` to get frames as quickly as they render), `\"framing\"` (`face` default for a square close-up, or `photo` for the whole photo with the face blended back in, up to 1280 px on its long side; `ready` gives `width` and `height`) and `\"voice\"`, `\"language\"`, `\"tts_model\"` and `\"tts_quality\"` (a quality tier such as `higher_quality` or `faster`, the app setting if left out) as defaults for `say`. The voice model loads during start so the first `say` is quick. Send `\"warm_tts\": false` if you only send your own audio. The server answers with `loading` messages while models download and load, then `ready`.\n2. **Speak**: `{\"type\": \"say\", \"id\": \"m1\", \"text\": \"...\", \"voice\": \"Morgan\", \"language\": \"English\"}` speaks in a saved voice. `tts_model` and `tts_quality` can also be set per `say`. Or send your own speech: `{\"type\": \"audio_begin\", \"id\": \"a1\", \"sample_rate\": 24000}`, then binary messages of 16-bit mono PCM, then `{\"type\": \"audio_end\"}`.\n3. **Receive**: binary frames, plus `started` and `done` messages for each `id`. Each frame is a 20-byte little-endian header (`kind` u8 with 1 for speech and 2 for idle, `id_length` u8, reserved u16, `epoch` u32, `index` u32, `audio_offset` u32, `jpeg_length` u32), then the id, then a JPEG, then 40 ms of 16-bit mono PCM at the `sample_rate` from `ready`. Idle frames carry no audio.\n4. **Control**: `{\"type\": \"interrupt\"}` stops the current speech and drops queued speech, `{\"type\": \"clear\"}` drops only the queue, and `{\"type\": \"played\", \"samples\": N, \"epoch\": E}` reports how many speech samples you have played in the current epoch. With `realtime` pace the server stays about one second ahead of what you report, or of the clock if you never report.\n\nAfter an interrupt the server sends `interrupted` with a new `epoch`. Drop any frames with an older epoch. One live session runs at a time.", "version": "2.0.0" }, "paths": { "/api/v1/speak": { "post": { "tags": [ "Agent" ], "summary": "Speak text out loud in a saved voice", "description": "REST mirror of the `vcp_speak` MCP tool for non-MCP agents and scripts.\n\nStreams speech with the resolved voice/model. `deliver: play`\nplays it here (desktop UI via `GET /api/v1/events/speak` when\nsubscribed, else the default output device) and blocks until\ndone. `deliver: url` plays nothing on this machine and returns\na progressive stream URL immediately. Speech is ephemeral —\nnothing is written to history.", "operationId": "speak_api_v1_speak_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakResponse" } } } }, "400": { "description": "No voice resolved (none passed, no default configured) or unknown model." }, "404": { "description": "The requested voice was not found." }, "500": { "description": "Generation failed." }, "504": { "description": "Generation timed out (600s limit)." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/audio/speech": { "post": { "tags": [ "Agent" ], "summary": "OpenAI-compatible text-to-speech", "description": "Drop-in for OpenAI's `POST /v1/audio/speech`, so OpenAI-compatible\nclients (OpenClaw, etc.) can point a `baseUrl` at this server. Send the\nAPI key as `Authorization: Bearer `. OpenAI model/voice names fall\nback to the configured agent defaults. Speech is ephemeral — nothing is\nwritten to history, nothing plays on this machine.", "operationId": "openai_speech_v1_audio_speech_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAISpeechRequest" } } }, "required": true }, "responses": { "200": { "description": "Audio bytes, streamed progressively while synthesis runs.", "content": { "application/json": { "schema": {} }, "audio/mpeg": {}, "audio/wav": {} } }, "400": { "description": "No voice resolved, or mp3 requested without bundled ffmpeg." }, "500": { "description": "Generation failed." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/events/speak": { "get": { "tags": [ "Agent" ], "summary": "SSE stream of agent speak events", "description": "Server-sent events for agent speech. The desktop UI subscribes so\nagent-generated audio plays inside the app; while at least one\nsubscriber is connected, local fallback playback is suppressed.", "operationId": "speak_events_api_v1_events_speak_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/health": { "get": { "tags": [ "Health" ], "summary": "Health check", "description": "Returns {status: \"ok\"} if the server is running.", "operationId": "health_api_v1_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } } } } }, "/api/v1/app/shutdown": { "post": { "tags": [ "Health" ], "summary": "Shut down the app", "description": "Quit the app. In the desktop app this closes the window, the same as its close button.\nBrowser requests from other sites are refused.", "operationId": "shutdown_api_v1_app_shutdown_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "403": { "description": "The request came from a web page on another site." }, "409": { "description": "A data folder move is in progress." } } } }, "/api/v1/system/info": { "get": { "tags": [ "System" ], "summary": "Get system hardware info", "description": "Return a human-readable string of GPU name, VRAM, and driver info.", "operationId": "system_info_api_v1_system_info_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemInfoResponse" } } } } } } }, "/api/v1/youtube/download": { "post": { "tags": [ "YouTube" ], "summary": "Download YouTube audio for trimming", "description": "Download a YouTube URL's audio and store it server-side as a temp WAV.\n\nReturns {temp_id, duration, title, start_time}. Then POST /api/v1/\nyoutube/slice with a desired range to get a trimmed clip as base64.", "operationId": "youtube_download_api_v1_youtube_download_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/youtube/slice": { "post": { "tags": [ "YouTube" ], "summary": "Slice a range from a YouTube temp WAV", "description": "Cut [start, end] seconds out of the temp WAV and return base64 WAV.", "operationId": "youtube_slice_api_v1_youtube_slice_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/youtube/audio/{temp_id}": { "delete": { "tags": [ "YouTube" ], "summary": "Delete a YouTube temp WAV", "description": "Best-effort cleanup of a temp WAV when the user closes the modal.", "operationId": "youtube_cleanup_api_v1_youtube_audio__temp_id__delete", "parameters": [ { "name": "temp_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Temp Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/youtube/transcribe": { "post": { "tags": [ "YouTube" ], "summary": "Transcribe a YouTube temp WAV without round-tripping bytes", "description": "Start transcription on a previously-downloaded YouTube temp WAV.\nAvoids base64-encoding multi-MB audio across the JS bridge.", "operationId": "youtube_transcribe_api_v1_youtube_transcribe_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/system/backend": { "get": { "tags": [ "System" ], "summary": "Get PyTorch backend", "description": "Return the configured PyTorch backend name (cuda, mlx, or cpu) from config.", "operationId": "system_backend_api_v1_system_backend_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemBackendResponse" } } } } } } }, "/api/v1/settings/audio-format": { "get": { "tags": [ "Settings" ], "summary": "Get output audio format", "description": "Return available output audio formats (wav, mp3, etc.) and current selection.", "operationId": "get_audio_format_setting_api_v1_settings_audio_format_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioFormatGetResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set output audio format", "description": "Set the output audio format for generated speech.", "operationId": "set_audio_format_setting_api_v1_settings_audio_format_put", "parameters": [ { "name": "format", "in": "query", "required": true, "schema": { "type": "string", "description": "Audio format ID (e.g. 'wav', 'mp3')", "title": "Format" }, "description": "Audio format ID (e.g. 'wav', 'mp3')" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioFormatSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audio/convert": { "post": { "tags": [ "Audio" ], "summary": "Convert audio format", "description": "Convert base64-encoded WAV audio to another format (mp3, flac). Returns the converted audio as base64.", "operationId": "convert_audio_api_v1_audio_convert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioConvertRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioConvertResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/emotional-clone-engine": { "get": { "tags": [ "Settings" ], "summary": "Get emotional clone engine", "description": "Return the active emotional-clone engine and the emotions steering offers.", "operationId": "get_emotional_clone_engine_setting_api_v1_settings_emotional_clone_engine_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set emotional clone engine", "operationId": "set_emotional_clone_engine_setting_api_v1_settings_emotional_clone_engine_put", "parameters": [ { "name": "engine", "in": "query", "required": true, "schema": { "type": "string", "description": "steering or voice_change", "title": "Engine" }, "description": "steering or voice_change" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/model-quality": { "get": { "tags": [ "Settings" ], "summary": "Get TTS model quality", "description": "Return quality presets available for the current generation mode.", "operationId": "get_model_quality_setting_api_v1_settings_model_quality_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelQualityGetResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set TTS model quality", "description": "Set TTS model quality. Unloads the current model and clears voice prompt cache if changed.", "operationId": "set_model_quality_setting_api_v1_settings_model_quality_put", "parameters": [ { "name": "quality", "in": "query", "required": true, "schema": { "type": "string", "description": "Quality preset ID", "title": "Quality" }, "description": "Quality preset ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelQualitySetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/generation-mode": { "get": { "tags": [ "Settings" ], "summary": "Get generation mode", "description": "Return available generation modes filtered by active model's capabilities.", "operationId": "get_generation_mode_setting_api_v1_settings_generation_mode_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModeOptionsResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set generation mode", "description": "Switch generation mode. Validates mode is supported by active model.", "operationId": "set_generation_mode_setting_api_v1_settings_generation_mode_put", "parameters": [ { "name": "mode", "in": "query", "required": true, "schema": { "type": "string", "description": "Mode: 'clone', 'design', 'tts', or 'stt'", "title": "Mode" }, "description": "Mode: 'clone', 'design', 'tts', or 'stt'" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetModeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/preferences/{key}": { "get": { "tags": [ "Settings" ], "summary": "Get a UI preference", "operationId": "get_pref_api_v1_preferences__key__get", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } }, { "name": "default", "in": "query", "required": false, "schema": { "type": "string", "title": "Default" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set a UI preference", "operationId": "set_pref_api_v1_preferences__key__put", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string", "title": "Value" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/low-vram": { "get": { "tags": [ "Settings" ], "summary": "Get low VRAM mode", "description": "Return whether low VRAM mode is enabled.", "operationId": "get_low_vram_setting_api_v1_settings_low_vram_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LowVramGetResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set low VRAM mode", "description": "Toggle low VRAM mode. Unloads the current TTS model if one is loaded.", "operationId": "set_low_vram_setting_api_v1_settings_low_vram_put", "parameters": [ { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolean", "description": "Enable or disable low VRAM mode", "title": "Enabled" }, "description": "Enable or disable low VRAM mode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LowVramSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/rocm-flash-attention": { "get": { "tags": [ "Settings" ], "summary": "Get ROCm flash attention", "description": "Return whether AOTriton flash attention is enabled, and whether it applies here.", "operationId": "get_rocm_flash_attention_setting_api_v1_settings_rocm_flash_attention_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RocmFlashAttentionGetResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set ROCm flash attention", "description": "Toggle AOTriton flash attention. Takes effect on the next launch.", "operationId": "set_rocm_flash_attention_setting_api_v1_settings_rocm_flash_attention_put", "parameters": [ { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolean", "description": "Enable or disable AOTriton flash attention", "title": "Enabled" }, "description": "Enable or disable AOTriton flash attention" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RocmFlashAttentionSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/hf-endpoint": { "get": { "tags": [ "Settings" ], "summary": "Get HuggingFace endpoint mode", "description": "Return the user's HuggingFace endpoint preference ('auto', 'direct', or 'mirror').", "operationId": "get_hf_endpoint_mode_setting_api_v1_settings_hf_endpoint_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set HuggingFace endpoint mode", "description": "Set the HuggingFace endpoint preference.\n\nClears the session probe cache so subsequent downloads pick up the new preference immediately.", "operationId": "set_hf_endpoint_mode_setting_api_v1_settings_hf_endpoint_put", "parameters": [ { "name": "mode", "in": "query", "required": true, "schema": { "type": "string", "description": "One of 'auto', 'direct', 'mirror'", "title": "Mode" }, "description": "One of 'auto', 'direct', 'mirror'" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/ui-language": { "get": { "tags": [ "Settings" ], "summary": "Get UI language", "description": "Return the stored UI language code, or null if the user never picked one.", "operationId": "get_ui_language_setting_api_v1_settings_ui_language_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UiLanguageGetResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set UI language", "description": "Set the UI language code and switch the i18n locale immediately.", "operationId": "set_ui_language_setting_api_v1_settings_ui_language_put", "parameters": [ { "name": "language", "in": "query", "required": true, "schema": { "type": "string", "description": "ISO language code (e.g. 'en', 'de', 'ja')", "title": "Language" }, "description": "ISO language code (e.g. 'en', 'de', 'ja')" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UiLanguageSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/asr-model": { "get": { "tags": [ "Settings" ], "summary": "Get ASR models", "description": "Return all selectable ASR models. Empty options list on macOS (single MLX build).", "operationId": "get_asr_models_setting_api_v1_settings_asr_model_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsrModelsGetResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set ASR model", "description": "Set the ASR model. The new model loads on next transcription.", "operationId": "set_asr_model_setting_api_v1_settings_asr_model_put", "parameters": [ { "name": "model_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Model ID", "title": "Model Id" }, "description": "Model ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsrModelSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/diarization-engine": { "get": { "tags": [ "Settings" ], "summary": "Get speaker detection engines", "operationId": "get_diarization_engines_setting_api_v1_settings_diarization_engine_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set speaker detection engine", "operationId": "set_diarization_engine_setting_api_v1_settings_diarization_engine_put", "parameters": [ { "name": "engine", "in": "query", "required": true, "schema": { "type": "string", "description": "pyannote or nemotron", "title": "Engine" }, "description": "pyannote or nemotron" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/mic-ptt-shortcut": { "get": { "tags": [ "Settings" ], "summary": "Get mic PTT shortcut", "description": "Return the configured mic push-to-talk shortcut (modifier + key).", "operationId": "get_mic_ptt_shortcut_setting_api_v1_settings_mic_ptt_shortcut_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MicPttShortcutResponse" } } } } } }, "put": { "tags": [ "Settings" ], "summary": "Set mic PTT shortcut", "description": "Set the mic PTT shortcut. Rejects values outside the allowed dropdown set.", "operationId": "set_mic_ptt_shortcut_setting_api_v1_settings_mic_ptt_shortcut_put", "parameters": [ { "name": "modifier", "in": "query", "required": true, "schema": { "type": "string", "description": "PTT modifier ('Alt' or 'Ctrl')", "title": "Modifier" }, "description": "PTT modifier ('Alt' or 'Ctrl')" }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "description": "PTT key", "title": "Key" }, "description": "PTT key" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MicPttShortcutSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/http-api": { "get": { "tags": [ "Settings" ], "summary": "Get HTTP API settings", "description": "Return whether the HTTP API is enabled and its configured port.", "operationId": "get_http_api_setting_api_v1_settings_http_api_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiSettingResponse" } } } } } } }, "/api/v1/settings/http-api-enabled": { "put": { "tags": [ "Settings" ], "summary": "Enable/disable HTTP API", "description": "Toggle the HTTP API server on or off in config. Requires app restart to take effect.", "operationId": "set_http_api_enabled_api_v1_settings_http_api_enabled_put", "parameters": [ { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolean", "description": "Enable or disable the HTTP API", "title": "Enabled" }, "description": "Enable or disable the HTTP API" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiSettingSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/http-api-port": { "put": { "tags": [ "Settings" ], "summary": "Set HTTP API port", "description": "Change the HTTP API port in config. Requires app restart to take effect.", "operationId": "set_http_api_port_api_v1_settings_http_api_port_put", "parameters": [ { "name": "port", "in": "query", "required": true, "schema": { "type": "integer", "description": "Port number (1-65535)", "title": "Port" }, "description": "Port number (1-65535)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiSettingSetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/mcp": { "get": { "tags": [ "Settings" ], "summary": "Get MCP agent-voice settings", "description": "Return the default agent voice/model, the MCP endpoint URL, and the OpenAI-compatible TTS base URL.", "operationId": "get_mcp_settings_endpoint_api_v1_settings_mcp_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/settings/mcp-default-voice": { "put": { "tags": [ "Settings" ], "summary": "Set default agent voice", "operationId": "set_mcp_default_voice_endpoint_api_v1_settings_mcp_default_voice_put", "parameters": [ { "name": "voice_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Saved voice ID. Omit to clear.", "title": "Voice Id" }, "description": "Saved voice ID. Omit to clear." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/api-key": { "put": { "tags": [ "Settings" ], "summary": "Set or clear the API key", "description": "When a key is set, every API/MCP request must present it via X-API-Key, Authorization: Bearer, or ?api_key=. Applies immediately, no restart needed. Omit `key` to clear.", "operationId": "set_api_key_endpoint_api_v1_settings_api_key_put", "parameters": [ { "name": "key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 8 }, { "type": "null" } ], "description": "New API key (min 8 chars). Omit to clear.", "title": "Key" }, "description": "New API key (min 8 chars). Omit to clear." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/settings/mcp-default-model": { "put": { "tags": [ "Settings" ], "summary": "Set default agent model", "operationId": "set_mcp_default_model_endpoint_api_v1_settings_mcp_default_model_put", "parameters": [ { "name": "family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model family. Omit to clear.", "title": "Family" }, "description": "Model family. Omit to clear." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/setup/status": { "get": { "tags": [ "Setup" ], "summary": "Check if setup is required", "description": "Check whether first-run setup is needed (missing backend, Python upgrade, etc.).", "operationId": "setup_status_api_v1_setup_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupStatusResponse" } } } } } } }, "/api/v1/setup/options": { "get": { "tags": [ "Setup" ], "summary": "Get setup options", "description": "Detect GPUs and return available backend installation options for the setup screen.", "operationId": "setup_options_api_v1_setup_options_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupOptionsResponse" } } } } } } }, "/api/v1/setup/start": { "post": { "tags": [ "Setup" ], "summary": "Install backend", "description": "Start background installation of the chosen compute backend (mlx/cuda/cpu).", "operationId": "setup_start_api_v1_setup_start_post", "parameters": [ { "name": "backend", "in": "query", "required": true, "schema": { "type": "string", "description": "Backend to install: 'mlx', 'cuda', or 'cpu'", "title": "Backend" }, "description": "Backend to install: 'mlx', 'cuda', or 'cpu'" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupStartResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/setup/progress": { "get": { "tags": [ "Setup" ], "summary": "Poll setup progress", "description": "Return current backend installation status, message, and percentage.", "operationId": "setup_progress_api_v1_setup_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupProgressResponse" } } } } } } }, "/api/v1/setup/reset": { "post": { "tags": [ "Setup" ], "summary": "Reset setup", "description": "Mark setup as incomplete so the backend can be changed on next launch.", "operationId": "setup_reset_api_v1_setup_reset_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } } } } }, "/api/v1/system/version": { "get": { "tags": [ "System" ], "summary": "Get app version", "description": "Read the app version from version.txt.", "operationId": "app_version_api_v1_system_version_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppVersionResponse" } } } } } } }, "/api/v1/system/gpu-devices": { "get": { "tags": [ "System" ], "summary": "List CUDA GPU devices", "description": "Return available CUDA devices with names/VRAM and the currently selected index.", "operationId": "gpu_devices_api_v1_system_gpu_devices_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GpuDevicesResponse" } } } } } } }, "/api/v1/system/gpu-device": { "put": { "tags": [ "System" ], "summary": "Select CUDA GPU device", "description": "Switch the active CUDA device. Unloads both TTS and ASR models for device migration.", "operationId": "set_gpu_device_api_v1_system_gpu_device_put", "parameters": [ { "name": "index", "in": "query", "required": true, "schema": { "type": "integer", "description": "CUDA device index", "title": "Index" }, "description": "CUDA device index" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetGpuDeviceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cache/info": { "get": { "tags": [ "Cache" ], "summary": "Get cache info", "description": "Return model cache size, pip cache size, and data folder paths.", "operationId": "cache_info_api_v1_cache_info_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CacheInfoResponse" } } } } } } }, "/api/v1/cache/clear-models": { "post": { "tags": [ "Cache" ], "summary": "Delete model cache", "description": "Delete all downloaded model files and recreate the empty cache directory.", "operationId": "clear_model_cache_api_v1_cache_clear_models_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } } } } }, "/api/v1/cache/clear-pip": { "post": { "tags": [ "Cache" ], "summary": "Delete pip cache", "description": "Delete all cached pip downloads and recreate the empty cache directory.", "operationId": "clear_pip_cache_api_v1_cache_clear_pip_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } } } } }, "/api/v1/gpu/install": { "post": { "tags": [ "GPU Install" ], "summary": "Install GPU acceleration", "description": "Start GPU acceleration package installation in a background thread.", "operationId": "start_gpu_install_api_v1_gpu_install_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationStartedResponse" } } } } } } }, "/api/v1/gpu/install/progress": { "get": { "tags": [ "GPU Install" ], "summary": "Poll GPU install progress", "description": "Return current GPU acceleration installation status and percentage.", "operationId": "gpu_install_progress_api_v1_gpu_install_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelLoadProgressResponse" } } } } } } }, "/api/v1/model/status": { "get": { "tags": [ "Model" ], "summary": "Get loaded model info", "description": "Return whether a TTS model is loaded, and if so its type, quality, and name.", "operationId": "model_status_api_v1_model_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelStatusResponse" } } } } } } }, "/api/v1/model/load": { "post": { "tags": [ "Model" ], "summary": "Load TTS model", "description": "Load or switch the TTS model.\n\n**A model must be loaded before any generation endpoint will work.**\nIf the requested mode/quality is already loaded, returns immediately\nwith `status: \"already_loaded\"`. Otherwise begins async loading —\npoll `GET /api/v1/model/load/progress` until `status: \"complete\"`.\n\nSwitching generation mode (clone / design / tts) requires a different\nmodel variant and triggers a reload.", "operationId": "model_load_api_v1_model_load_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for loading to complete", "default": false, "title": "Sync" }, "description": "Wait for loading to complete" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelLoadRequest", "default": {} } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelLoadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/model/load/progress": { "get": { "tags": [ "Model" ], "summary": "Poll model load progress", "description": "Return current model loading status, message, and percentage.", "operationId": "model_load_progress_api_v1_model_load_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelLoadProgressResponse" } } } } } } }, "/api/v1/models": { "get": { "tags": [ "Model" ], "summary": "List available TTS models", "description": "List all available TTS model families and their capabilities.", "operationId": "list_models_api_v1_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelListResponse" } } } } } } }, "/api/v1/models/active": { "get": { "tags": [ "Model" ], "summary": "Get active model capabilities", "description": "Get the active TTS model's capabilities.", "operationId": "get_active_model_api_v1_models_active_get", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Generation mode to resolve the per-mode model preference for", "title": "Mode" }, "description": "Generation mode to resolve the per-mode model preference for" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCapabilitiesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Model" ], "summary": "Switch active TTS model", "description": "Save the preferred TTS model family and return its capabilities.\n\nUnloads the current model. With `auto_load` set, the new model starts\nloading right away.", "operationId": "switch_active_model_api_v1_models_active_put", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchModelRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCapabilitiesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/models/{model_family}/status": { "get": { "tags": [ "Model" ], "summary": "Check model download status", "description": "Check if model weights are downloaded for each variant tier.", "operationId": "check_model_status_api_v1_models__model_family__status_get", "parameters": [ { "name": "model_family", "in": "path", "required": true, "schema": { "type": "string", "title": "Model Family" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/models/load-progress": { "get": { "tags": [ "Model" ], "summary": "Poll model load/download progress", "description": "Return current model loading/downloading progress.", "operationId": "models_load_progress_api_v1_models_load_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/generation/progress": { "get": { "tags": [ "Generation" ], "summary": "Poll generation progress", "description": "Return current speech generation status, message, and percentage.", "operationId": "generation_progress_api_v1_generation_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationProgressResponse" } } } } } } }, "/api/v1/generation/result": { "get": { "tags": [ "Generation" ], "summary": "Get last generation result", "description": "Return the most recent generation result including base64-encoded audio.", "operationId": "generation_result_api_v1_generation_result_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResult" } } } } } } }, "/api/v1/generation/stop": { "post": { "tags": [ "Generation" ], "summary": "Cancel generation", "description": "Cancel the active generation, clear all pending queue jobs, and set cancelled flag.", "operationId": "generation_stop_api_v1_generation_stop_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationStopResponse" } } } } } } }, "/api/v1/generation/queue": { "get": { "tags": [ "Generation" ], "summary": "Get queue status", "description": "Return the number of pending jobs and whether a generation is currently running.\n\nScoped per-user: callers only see their own queue depth and whether\ntheir own job is the active one.", "operationId": "generation_queue_status_api_v1_generation_queue_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationQueueResponse" } } } } } } }, "/api/v1/generation/clone": { "post": { "tags": [ "Clone" ], "summary": "Generate cloned speech", "description": "Clone a voice from reference audio or a saved voice ID.\n\nProvide `ref_audio_base64` with a 3-15 second WAV clip of clear speech,\nplus `ref_text` (the transcript of that audio) for best quality.\nAlternatively, provide a `voice_id` from the voice library — the saved\naudio is used automatically, and `ref_audio_base64` can be omitted.\n\nUse `?sync=true` to block until audio is ready (up to 600s).\nOtherwise, poll `GET /api/v1/generation/progress` and `GET /api/v1/generation/result`.", "operationId": "start_clone_api_v1_generation_clone_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for generation to complete and return audio directly", "default": false, "title": "Sync" }, "description": "Wait for generation to complete and return audio directly" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneRequest" } } } }, "responses": { "200": { "description": "Generation started (async) or completed result (sync).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ], "title": "Response Start Clone Api V1 Generation Clone Post", "oneOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ] } } } }, "400": { "description": "Invalid voice_id format." }, "504": { "description": "Sync generation timed out (600s limit)." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/generation/clone/stream": { "post": { "tags": [ "Clone" ], "summary": "Stream cloned speech", "description": "Start a streaming voice clone session.\n\nReturns a `session_id` immediately. Connect to\n`GET /api/v1/streaming/{session_id}/audio` to receive chunked WAV audio\nas it is generated. Call `POST /api/v1/streaming/{session_id}/finalize`\nwhen done to get the complete audio as base64.\n\nCancels any in-progress generation to prioritize the stream.", "operationId": "start_clone_stream_api_v1_generation_clone_stream_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamStartedResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/generation/design": { "post": { "tags": [ "Design" ], "summary": "Generate designed speech", "description": "Generate speech using a natural language voice description.\n\nDescribe the desired voice in `instruct_text` (e.g. 'a deep male voice\nwith an American accent, speaking confidently'). The model creates a\nnew voice matching the description each time — results vary between calls.\nTo reuse a designed voice, save it via `POST /api/v1/voices` and use\n`POST /api/v1/generation/design/saved` instead.", "operationId": "start_design_api_v1_generation_design_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for generation to complete and return audio directly", "default": false, "title": "Sync" }, "description": "Wait for generation to complete and return audio directly" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesignRequest" } } } }, "responses": { "200": { "description": "Generation started (async) or completed result (sync).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ], "title": "Response Start Design Api V1 Generation Design Post", "oneOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ] } } } }, "504": { "description": "Sync generation timed out (600s limit)." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/generation/design/saved": { "post": { "tags": [ "Design" ], "summary": "Generate from saved design voice", "description": "Generate speech using a previously saved voice design. Validates voice_id exists on disk.", "operationId": "start_saved_design_api_v1_generation_design_saved_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for generation to complete and return audio directly", "default": false, "title": "Sync" }, "description": "Wait for generation to complete and return audio directly" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedDesignRequest" } } } }, "responses": { "200": { "description": "Generation started (async) or completed result (sync).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ], "title": "Response Start Saved Design Api V1 Generation Design Saved Post", "oneOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ] } } } }, "400": { "description": "Invalid voice_id format." }, "404": { "description": "Saved design voice not found." }, "504": { "description": "Sync generation timed out (600s limit)." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/generation/design/saved/stream": { "post": { "tags": [ "Design" ], "summary": "Stream from saved design voice", "description": "Start a streaming session using a saved voice design. Cancels any in-progress generation first.", "operationId": "start_saved_design_stream_api_v1_generation_design_saved_stream_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedDesignRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamStartedResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tts/speakers": { "get": { "tags": [ "TTS" ], "summary": "List built-in speakers", "description": "Return the list of built-in TTS speaker IDs, names, and descriptions.\n\nWhen `model_family` is supplied and valid, returns speakers belonging\nto that specific model — needed so audiobook callers can list voices\ncompatible with a per-span model override, not just the globally\nactive model.", "operationId": "tts_speakers_api_v1_tts_speakers_get", "parameters": [ { "name": "model_family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional model family. Defaults to the active model (with fallback to any model that publishes built-in speakers).", "title": "Model Family" }, "description": "Optional model family. Defaults to the active model (with fallback to any model that publishes built-in speakers)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakersResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tts/languages": { "get": { "tags": [ "TTS" ], "summary": "List supported languages", "description": "Return the list of supported TTS languages.", "operationId": "tts_languages_api_v1_tts_languages_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguagesResponse" } } } } } } }, "/api/v1/tts/generate": { "post": { "tags": [ "TTS" ], "summary": "Generate speech from text", "description": "Generate speech using a built-in speaker voice, with optional style instruction.", "operationId": "start_tts_api_v1_tts_generate_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for generation to complete and return audio directly", "default": false, "title": "Sync" }, "description": "Wait for generation to complete and return audio directly" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TTSRequest" } } } }, "responses": { "200": { "description": "Generation started (async) or completed result (sync).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ], "title": "Response Start Tts Api V1 Tts Generate Post", "oneOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ] } } } }, "422": { "description": "Invalid speaker ID. Use `GET /api/v1/tts/speakers` to list valid IDs." }, "504": { "description": "Sync generation timed out (600s limit)." } } } }, "/api/v1/conversion/convert": { "post": { "tags": [ "Conversion" ], "summary": "Convert speech to a target voice", "description": "Convert the speaker identity of source audio to a target voice.\n\nKeeps the words, timing, and prosody of the source recording while\nre-rendering it in the target speaker's voice (zero-shot, via the\nChatterbox S3Gen stack). Provide either `target_voice_id` (saved\nlibrary voice) or `target_audio_base64` (6-10s of clean speech).\n\nUse `?sync=true` to block until audio is ready. Otherwise poll\n`GET /api/v1/conversion/progress` and `GET /api/v1/conversion/result`.", "operationId": "start_voice_conversion_api_v1_conversion_convert_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for conversion to complete and return audio directly", "default": false, "title": "Sync" }, "description": "Wait for conversion to complete and return audio directly" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertVoiceRequest" } } } }, "responses": { "200": { "description": "Conversion started (async) or completed result (sync).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ], "title": "Response Start Voice Conversion Api V1 Conversion Convert Post", "oneOf": [ { "$ref": "#/components/schemas/GenerationStartedResponse" }, { "$ref": "#/components/schemas/GenerationResult" } ] } } } }, "400": { "description": "Invalid voice_id format." }, "504": { "description": "Sync conversion timed out (600s limit)." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversion/models": { "get": { "tags": [ "Conversion" ], "summary": "List voice conversion models", "operationId": "conversion_models_api_v1_conversion_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/conversion/progress": { "get": { "tags": [ "Conversion" ], "summary": "Get conversion progress", "operationId": "conversion_progress_api_v1_conversion_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationProgressResponse" } } } } } } }, "/api/v1/conversion/result": { "get": { "tags": [ "Conversion" ], "summary": "Get last conversion result", "description": "The last conversion result, or null when there is none yet.", "operationId": "conversion_result_api_v1_conversion_result_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationResult" }, { "type": "null" } ], "title": "Response Conversion Result Api V1 Conversion Result Get" } } } } } } }, "/api/v1/conversion/stop": { "post": { "tags": [ "Conversion" ], "summary": "Cancel voice conversion", "operationId": "conversion_stop_api_v1_conversion_stop_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/transcription/start": { "post": { "tags": [ "Transcription" ], "summary": "Transcribe audio", "description": "Start a speech-to-text transcription.\n\nIn **async** mode (default), returns immediately with `{started: true}`.\nPoll `/api/v1/transcription/progress` for status and results.\n\nIn **sync** mode (`sync=true`), blocks until transcription completes and\nreturns the result directly. When `output_format=srt` and\n`return_timestamps=true`, returns an SRT subtitle file instead of JSON.", "operationId": "start_transcription_api_v1_transcription_start_post", "parameters": [ { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Wait for transcription to complete and return the result directly", "default": false, "title": "Sync" }, "description": "Wait for transcription to complete and return the result directly" }, { "name": "output_format", "in": "query", "required": false, "schema": { "enum": [ "json", "srt" ], "type": "string", "description": "Response format when sync=true. 'srt' returns SubRip subtitles (requires return_timestamps=true)", "default": "json", "title": "Output Format" }, "description": "Response format when sync=true. 'srt' returns SubRip subtitles (requires return_timestamps=true)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscribeRequest" } } } }, "responses": { "200": { "description": "Transcription started (async) or completed (sync).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TranscriptionStartedResponse" }, { "$ref": "#/components/schemas/TranscriptionSyncResult" } ], "title": "Response Start Transcription Api V1 Transcription Start Post", "oneOf": [ { "$ref": "#/components/schemas/TranscriptionStartedResponse" }, { "$ref": "#/components/schemas/TranscriptionSyncResult" } ] } }, "text/srt": { "schema": { "type": "string" }, "example": "1\n00:00:00,000 --> 00:00:02,500\nHello world\n" } } }, "504": { "description": "Sync transcription stalled — no progress for 300s." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/transcription/cancel": { "post": { "tags": [ "Transcription" ], "summary": "Cancel an in-flight transcription", "description": "Cancel the running transcription.\n\nTranscription stops at the end of the chunk it is working on, so it can\ntake a few seconds to stop.", "operationId": "transcription_cancel_api_v1_transcription_cancel_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/transcription/progress": { "get": { "tags": [ "Transcription" ], "summary": "Poll transcription progress", "description": "Poll transcription status after an async `/transcription/start` call.\n\nReturns progress percentage, status, and — once complete — the\ntranscribed text, detected language, and optional word-level timestamps.", "operationId": "transcription_progress_api_v1_transcription_progress_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionProgressResponse" } } } } } } }, "/api/v1/translate": { "post": { "tags": [ "Translation" ], "summary": "Translate texts", "operationId": "translate_api_v1_translate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/streaming/{session_id}": { "get": { "tags": [ "Streaming" ], "summary": "Get streaming session info", "description": "Return status, chunk count, and sample rate for a streaming session.", "operationId": "streaming_session_info_api_v1_streaming__session_id__get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamingSessionInfoResponse" } } } }, "404": { "description": "Session not found or expired (sessions expire after 10 minutes)." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/streaming/{session_id}/audio": { "get": { "tags": [ "Streaming" ], "summary": "Stream session audio as WAV", "description": "Stream generated audio progressively while synthesis runs.\n\nBoth formats are replayable and resumable: reads never consume the\nsession buffer, and `Range: bytes=N-` requests resume from byte N\n(206), so players like ExoPlayer can recover from network drops.\nMP3 is encoded once per session into a buffer all readers share.\nThe stream ends when generation completes. 10-minute hard timeout.", "operationId": "stream_audio_api_v1_streaming__session_id__audio_get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "'wav' (PCM16) or 'mp3' (64kbps, transcoded once per session by the bundled ffmpeg)", "default": "wav", "title": "Format" }, "description": "'wav' (PCM16) or 'mp3' (64kbps, transcoded once per session by the bundled ffmpeg)" } ], "responses": { "200": { "description": "Streaming WAV audio (PCM 16-bit mono).", "content": { "application/json": { "schema": {} }, "audio/wav": {} } }, "404": { "description": "Session not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/streaming/{session_id}/finalize": { "post": { "tags": [ "Streaming" ], "summary": "Finalize streaming session", "description": "Collect all streamed audio into a complete WAV and return as base64.\n\nWaits for generation to complete, concatenates all chunks, stores the\nresult as the last generation result, and removes the session.\nCall this after the audio stream finishes to get the full audio.", "operationId": "finalize_streaming_session_api_v1_streaming__session_id__finalize_post", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResult" } } } }, "404": { "description": "Session not found or expired." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/voices": { "get": { "tags": [ "Voices" ], "summary": "List saved voices", "description": "Return all saved voices, optionally filtered by type (clone or design).", "operationId": "list_voices_api_v1_voices_get", "parameters": [ { "name": "voice_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by voice type: 'clone' or 'design'", "title": "Voice Type" }, "description": "Filter by voice type: 'clone' or 'design'" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Voices" ], "summary": "Save voice to library", "description": "Save a new voice (audio + transcript) to the voice library. Clone audio can be up to 30 seconds long. A clone longer than 15 seconds is cut to 15 seconds or less, on sentence ends where it can, and the response carries the cut voice.", "operationId": "save_voice_api_v1_voices_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveVoiceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceSaveResponse" } } } }, "400": { "description": "Clone audio is longer than 30 seconds." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/voices/{voice_id}": { "get": { "tags": [ "Voices" ], "summary": "Load voice by ID", "description": "Return a saved voice's audio, transcript, and metadata by ID.", "operationId": "load_voice_api_v1_voices__voice_id__get", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceLoadResponse" } } } }, "400": { "description": "Invalid voice ID format." }, "404": { "description": "Voice not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Voices" ], "summary": "Delete voice by ID", "description": "Permanently delete a saved voice and its files from disk.", "operationId": "delete_voice_api_v1_voices__voice_id__delete", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } }, "400": { "description": "Invalid voice ID format." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/voices/{voice_id}/name": { "post": { "tags": [ "Voices" ], "summary": "Rename a saved voice", "description": "Update a saved voice's display name.", "operationId": "rename_voice_api_v1_voices__voice_id__name_post", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameVoiceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } }, "400": { "description": "Invalid voice ID format." }, "404": { "description": "Voice not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/voices/{voice_id}/transcript": { "post": { "tags": [ "Voices" ], "summary": "Persist a transcript for a saved voice", "description": "Store a transcript on a saved voice and invalidate its baked clone prompt.", "operationId": "update_voice_transcript_api_v1_voices__voice_id__transcript_post", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTranscriptRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } }, "400": { "description": "Invalid voice ID format." }, "404": { "description": "Voice not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/voices/{voice_id}/audio": { "post": { "tags": [ "Voices" ], "summary": "Replace a saved voice's audio", "description": "Replace a saved voice's audio and its transcript together. Without `text` the transcript is cleared and the next generation transcribes the new audio.", "operationId": "update_voice_audio_api_v1_voices__voice_id__audio_post", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoiceAudioRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } }, "400": { "description": "Invalid voice ID format." }, "404": { "description": "Voice not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/voices/{voice_id}/align": { "post": { "tags": [ "Voices" ], "summary": "Align a saved voice's transcript to its audio", "description": "Find word timings for a saved voice's transcript, transcribing the audio when the voice has none. Waits until the voice is aligned. A voice that is already aligned, or holds no speech, returns at once unless `force` is set.", "operationId": "align_voice_api_v1_voices__voice_id__align_post", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignVoiceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignVoiceResponse" } } } }, "400": { "description": "Invalid voice ID format." }, "404": { "description": "Voice not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/history": { "get": { "tags": [ "History" ], "summary": "List generation history", "description": "Return all past generation results with metadata, newest first.", "operationId": "list_history_api_v1_history_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryListResponse" } } } } } }, "post": { "tags": [ "History" ], "summary": "Save generation to history", "description": "Persist a generation result (audio + metadata) to the history library.", "operationId": "save_to_history_api_v1_history_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveHistoryRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistorySaveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "History" ], "summary": "Clear all history", "description": "Delete all history items, optionally filtered by generation mode.", "operationId": "clear_history_api_v1_history_delete", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by generation mode: 'clone', 'design', or 'tts'", "title": "Mode" }, "description": "Filter by generation mode: 'clone', 'design', or 'tts'" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/history/{item_id}": { "get": { "tags": [ "History" ], "summary": "Load history item by ID", "description": "Return a history item's audio and full metadata by ID.", "operationId": "load_history_item_api_v1_history__item_id__get", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryLoadResponse" } } } }, "400": { "description": "Invalid item ID format." }, "404": { "description": "History item not found." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "History" ], "summary": "Delete history item by ID", "description": "Permanently delete a history item and its audio file from disk.", "operationId": "delete_history_item_api_v1_history__item_id__delete", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessMessageResponse" } } } }, "400": { "description": "Invalid item ID format." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects": { "get": { "tags": [ "Audiobook" ], "summary": "List all audiobook projects", "operationId": "audiobook_list_projects_api_v1_audiobook_projects_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "Audiobook" ], "summary": "Create a new audiobook project", "operationId": "audiobook_create_project_api_v1_audiobook_projects_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiobookCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/detect-speakers": { "post": { "tags": [ "Audiobook" ], "summary": "Detect speakers in pasted script text", "operationId": "audiobook_detect_speakers_api_v1_audiobook_detect_speakers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiobookDetectSpeakersRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}": { "get": { "tags": [ "Audiobook" ], "summary": "Get an audiobook project", "operationId": "audiobook_get_project_api_v1_audiobook_projects__project_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Audiobook" ], "summary": "Delete an audiobook project", "operationId": "audiobook_delete_project_api_v1_audiobook_projects__project_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "delete_designed_voices", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Delete Designed Voices" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/designed-voices": { "get": { "tags": [ "Audiobook" ], "summary": "Library voices this project designed", "operationId": "audiobook_designed_voice_ids_api_v1_audiobook_projects__project_id__designed_voices_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/name": { "put": { "tags": [ "Audiobook" ], "summary": "Rename an audiobook project", "operationId": "audiobook_rename_project_api_v1_audiobook_projects__project_id__name_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiobookRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/batch-status": { "get": { "tags": [ "Audiobook" ], "summary": "Lightweight live-batch progress (counts + currently-generating segment)", "operationId": "audiobook_batch_status_api_v1_audiobook_projects__project_id__batch_status_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combine-progress": { "get": { "tags": [ "Audiobook" ], "summary": "Stitch/encode progress for the ongoing combine or export", "operationId": "audiobook_combine_progress_api_v1_audiobook_projects__project_id__combine_progress_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/ingest-progress": { "get": { "tags": [ "Audiobook" ], "summary": "OCR ingestion progress", "operationId": "audiobook_ingest_progress_api_v1_audiobook_projects__project_id__ingest_progress_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/cancel-ingest": { "post": { "tags": [ "Audiobook" ], "summary": "Cancel an in-progress OCR ingestion", "operationId": "audiobook_cancel_ingest_api_v1_audiobook_projects__project_id__cancel_ingest_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combine-precheck": { "get": { "tags": [ "Audiobook" ], "summary": "Would a Preview / Export actually do work?", "operationId": "audiobook_precheck_combine_api_v1_audiobook_projects__project_id__combine_precheck_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combine-cancel": { "post": { "tags": [ "Audiobook" ], "summary": "Signal an in-flight combine/export to stop", "operationId": "audiobook_cancel_combine_api_v1_audiobook_projects__project_id__combine_cancel_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/clear-batch-flag": { "post": { "tags": [ "Audiobook" ], "summary": "Clear the persisted batch_in_progress flag", "operationId": "audiobook_clear_batch_in_progress_api_v1_audiobook_projects__project_id__clear_batch_flag_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/cover": { "post": { "tags": [ "Audiobook" ], "summary": "Upload a custom cover image", "operationId": "audiobook_upload_cover_api_v1_audiobook_projects__project_id__cover_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_audiobook_upload_cover_api_v1_audiobook_projects__project_id__cover_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Audiobook" ], "summary": "Get the project's cover image (custom overrides EPUB-derived)", "operationId": "audiobook_get_cover_api_v1_audiobook_projects__project_id__cover_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/generate": { "post": { "tags": [ "Audiobook" ], "summary": "Batch generate audio for segments", "operationId": "audiobook_generate_batch_api_v1_audiobook_projects__project_id__generate_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGenerateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/generate/cancel": { "post": { "tags": [ "Audiobook" ], "summary": "Cancel an in-flight generate_batch", "operationId": "audiobook_cancel_batch_api_v1_audiobook_projects__project_id__generate_cancel_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/reset-stuck": { "post": { "tags": [ "Audiobook" ], "summary": "Reset segments stuck in 'generating' status", "operationId": "audiobook_reset_stuck_api_v1_audiobook_projects__project_id__reset_stuck_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combine": { "post": { "tags": [ "Audiobook" ], "summary": "Combine all segment audio into a single file", "operationId": "audiobook_combine_audio_api_v1_audiobook_projects__project_id__combine_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combined/audio": { "get": { "tags": [ "Audiobook" ], "summary": "Get the combined audiobook file (rebuilds if stale)", "operationId": "audiobook_get_combined_audio_api_v1_audiobook_projects__project_id__combined_audio_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combined/boundaries": { "get": { "tags": [ "Audiobook" ], "summary": "Get segment boundaries within the combined audiobook", "operationId": "audiobook_get_combined_boundaries_api_v1_audiobook_projects__project_id__combined_boundaries_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/combined/url": { "get": { "tags": [ "Audiobook" ], "summary": "Resolve combined audio URL + boundaries in one call (rebuilds if stale)", "operationId": "audiobook_get_combined_url_api_v1_audiobook_projects__project_id__combined_url_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/export": { "post": { "tags": [ "Audiobook" ], "summary": "Export the audiobook project", "operationId": "audiobook_export_project_api_v1_audiobook_projects__project_id__export_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/export/download": { "get": { "tags": [ "Audiobook" ], "summary": "Download the previously-exported audiobook file", "description": "Download the file written by `POST /export` in the given format.", "operationId": "audiobook_export_download_api_v1_audiobook_projects__project_id__export_download_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "format", "in": "query", "required": true, "schema": { "type": "string", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/settings": { "put": { "tags": [ "Audiobook" ], "summary": "Update project settings", "operationId": "audiobook_update_project_settings_api_v1_audiobook_projects__project_id__settings_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/reparse": { "post": { "tags": [ "Audiobook" ], "summary": "Re-parse source file with current settings (destructive)", "operationId": "audiobook_reparse_project_api_v1_audiobook_projects__project_id__reparse_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_audiobook_reparse_project_api_v1_audiobook_projects__project_id__reparse_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/sanitize": { "post": { "tags": [ "Audiobook" ], "summary": "Sanitize every segment's text in a project", "operationId": "audiobook_sanitize_all_segments_api_v1_audiobook_projects__project_id__sanitize_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/reset-audio": { "post": { "tags": [ "Audiobook" ], "summary": "Invalidate all generated audio in a project (archives to history)", "operationId": "audiobook_reset_all_audio_api_v1_audiobook_projects__project_id__reset_audio_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/reset-audio-for-segments": { "post": { "tags": [ "Audiobook" ], "summary": "Reset audio for a specific list of segments", "operationId": "audiobook_reset_audio_for_segments_api_v1_audiobook_projects__project_id__reset_audio_for_segments_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetAudioForSegmentsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments": { "post": { "tags": [ "Audiobook" ], "summary": "Append a new segment to a project", "operationId": "audiobook_add_segment_api_v1_audiobook_projects__project_id__segments_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}": { "put": { "tags": [ "Audiobook" ], "summary": "Update a segment", "operationId": "audiobook_update_segment_api_v1_audiobook_projects__project_id__segments__segment_id__put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Audiobook" ], "summary": "Delete a segment", "operationId": "audiobook_delete_segment_api_v1_audiobook_projects__project_id__segments__segment_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/move": { "post": { "tags": [ "Audiobook" ], "summary": "Reorder a segment within its scope", "operationId": "audiobook_move_segment_api_v1_audiobook_projects__project_id__segments__segment_id__move_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentMoveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/split": { "post": { "tags": [ "Audiobook" ], "summary": "Split a segment at offset", "operationId": "audiobook_split_segment_api_v1_audiobook_projects__project_id__segments__segment_id__split_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentSplitRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{seg_id_a}/merge/{seg_id_b}": { "post": { "tags": [ "Audiobook" ], "summary": "Merge two adjacent segments", "operationId": "audiobook_merge_segments_api_v1_audiobook_projects__project_id__segments__seg_id_a__merge__seg_id_b__post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "seg_id_a", "in": "path", "required": true, "schema": { "type": "string", "title": "Seg Id A" } }, { "name": "seg_id_b", "in": "path", "required": true, "schema": { "type": "string", "title": "Seg Id B" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/bulk-delete": { "post": { "tags": [ "Audiobook" ], "summary": "Delete multiple segments at once", "operationId": "audiobook_bulk_delete_segments_api_v1_audiobook_projects__project_id__segments_bulk_delete_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSegmentIdsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/bulk-merge": { "post": { "tags": [ "Audiobook" ], "summary": "Merge N adjacent segments into one", "operationId": "audiobook_bulk_merge_segments_api_v1_audiobook_projects__project_id__segments_bulk_merge_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSegmentIdsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/spans/{span_index}/regenerate": { "post": { "tags": [ "Audiobook" ], "summary": "Regenerate audio for a single voice_span", "operationId": "audiobook_regenerate_span_api_v1_audiobook_projects__project_id__segments__segment_id__spans__span_index__regenerate_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } }, { "name": "span_index", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Index" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/generate": { "post": { "tags": [ "Audiobook" ], "summary": "Generate audio for a segment", "operationId": "audiobook_generate_segment_api_v1_audiobook_projects__project_id__segments__segment_id__generate_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/audio": { "get": { "tags": [ "Audiobook" ], "summary": "Get segment audio file", "operationId": "audiobook_get_segment_audio_api_v1_audiobook_projects__project_id__segments__segment_id__audio_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/history": { "get": { "tags": [ "Audiobook" ], "summary": "Get generation history for a segment", "operationId": "audiobook_get_segment_history_api_v1_audiobook_projects__project_id__segments__segment_id__history_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/history/{generation_id}/promote": { "post": { "tags": [ "Audiobook" ], "summary": "Promote a historical generation to current", "operationId": "audiobook_promote_generation_api_v1_audiobook_projects__project_id__segments__segment_id__history__generation_id__promote_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } }, { "name": "generation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Generation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/history/{generation_id}": { "delete": { "tags": [ "Audiobook" ], "summary": "Delete a historical generation", "operationId": "audiobook_delete_generation_api_v1_audiobook_projects__project_id__segments__segment_id__history__generation_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } }, { "name": "generation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Generation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Audiobook" ], "summary": "Rename a take (set or clear its custom display name)", "operationId": "audiobook_rename_take_api_v1_audiobook_projects__project_id__segments__segment_id__history__generation_id__patch", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } }, { "name": "generation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Generation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TakeRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Audiobook" ], "summary": "Get a single take's audio file (no-suffix alias)", "operationId": "audiobook_get_take_audio_no_suffix_api_v1_audiobook_projects__project_id__segments__segment_id__history__generation_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } }, { "name": "generation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Generation Id" } }, { "name": "download", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Download" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/history/{generation_id}/audio": { "get": { "tags": [ "Audiobook" ], "summary": "Get a single take's audio file", "operationId": "audiobook_get_take_audio_api_v1_audiobook_projects__project_id__segments__segment_id__history__generation_id__audio_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } }, { "name": "generation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Generation Id" } }, { "name": "download", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Download" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/upload-take": { "post": { "tags": [ "Audiobook" ], "summary": "Upload a WAV file as a new take in segment history", "operationId": "audiobook_upload_take_api_v1_audiobook_projects__project_id__segments__segment_id__upload_take_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_audiobook_upload_take_api_v1_audiobook_projects__project_id__segments__segment_id__upload_take_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/sanitize": { "post": { "tags": [ "Audiobook" ], "summary": "Sanitize a single segment's text", "operationId": "audiobook_sanitize_segment_api_v1_audiobook_projects__project_id__segments__segment_id__sanitize_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/lexicon": { "get": { "tags": [ "Audiobook" ], "summary": "List lexicon entries", "operationId": "audiobook_list_lexicon_api_v1_audiobook_projects__project_id__lexicon_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Audiobook" ], "summary": "Add a lexicon entry", "operationId": "audiobook_add_lexicon_entry_api_v1_audiobook_projects__project_id__lexicon_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LexiconAddRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/lexicon/{entry_id}": { "put": { "tags": [ "Audiobook" ], "summary": "Update a lexicon entry", "operationId": "audiobook_update_lexicon_entry_api_v1_audiobook_projects__project_id__lexicon__entry_id__put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LexiconUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Audiobook" ], "summary": "Delete a lexicon entry", "operationId": "audiobook_delete_lexicon_entry_api_v1_audiobook_projects__project_id__lexicon__entry_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/lexicon/import": { "post": { "tags": [ "Audiobook" ], "summary": "Import lexicon entries from elsewhere", "operationId": "audiobook_import_lexicon_entries_api_v1_audiobook_projects__project_id__lexicon_import_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LexiconImportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/lexicon/staleness": { "get": { "tags": [ "Audiobook" ], "summary": "Get lexicon staleness for generated segments", "operationId": "audiobook_get_lexicon_staleness_api_v1_audiobook_projects__project_id__lexicon_staleness_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/lexicon/find-sentence": { "get": { "tags": [ "Audiobook" ], "summary": "Find first sentence containing a phrase", "operationId": "audiobook_find_first_sentence_for_phrase_api_v1_audiobook_projects__project_id__lexicon_find_sentence_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "phrase", "in": "query", "required": true, "schema": { "type": "string", "title": "Phrase" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/voices": { "post": { "tags": [ "Audiobook" ], "summary": "Add a voice to a project", "operationId": "audiobook_add_project_voice_api_v1_audiobook_projects__project_id__voices_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceAddRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/voices/{voice_id}": { "put": { "tags": [ "Audiobook" ], "summary": "Update a project voice", "operationId": "audiobook_update_project_voice_api_v1_audiobook_projects__project_id__voices__voice_id__put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Audiobook" ], "summary": "Remove a voice from a project", "operationId": "audiobook_remove_project_voice_api_v1_audiobook_projects__project_id__voices__voice_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/voices/{voice_id}/default": { "put": { "tags": [ "Audiobook" ], "summary": "Set the default voice for a project", "operationId": "audiobook_set_default_voice_api_v1_audiobook_projects__project_id__voices__voice_id__default_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/sections": { "post": { "tags": [ "Audiobook" ], "summary": "Create a section", "operationId": "audiobook_create_section_api_v1_audiobook_projects__project_id__sections_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectionCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/sections/{section_id}": { "delete": { "tags": [ "Audiobook" ], "summary": "Delete a section (optionally with its segments)", "operationId": "audiobook_delete_section_api_v1_audiobook_projects__project_id__sections__section_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "section_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Section Id" } }, { "name": "delete_segments", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Delete Segments" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/sections/{section_id}/name": { "put": { "tags": [ "Audiobook" ], "summary": "Rename a section", "operationId": "audiobook_rename_section_api_v1_audiobook_projects__project_id__sections__section_id__name_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "section_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Section Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectionRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/llm-config": { "get": { "tags": [ "Audiobook" ], "summary": "Get the audiobook LLM config (api_key masked)", "operationId": "audiobook_get_llm_config_api_v1_audiobook_llm_config_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "put": { "tags": [ "Audiobook" ], "summary": "Set the audiobook LLM config", "operationId": "audiobook_set_llm_config_api_v1_audiobook_llm_config_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiobookLLMConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/llm-model": { "put": { "tags": [ "Audiobook" ], "summary": "Set the model used for speaker detection", "operationId": "audiobook_set_llm_model_api_v1_audiobook_llm_model_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiobookLLMModelRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/llm-models": { "get": { "tags": [ "Audiobook" ], "summary": "List available models for the configured LLM provider", "operationId": "audiobook_list_llm_models_api_v1_audiobook_llm_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/audiobook/projects/{project_id}/speaker-estimate": { "get": { "tags": [ "Audiobook" ], "summary": "Estimate tokens and cost for speaker detection", "operationId": "audiobook_speaker_estimate_api_v1_audiobook_projects__project_id__speaker_estimate_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "detect_emotions", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Detect Emotions" } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "default": "speakers", "title": "Mode" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/assign-speakers": { "post": { "tags": [ "Audiobook" ], "summary": "Start speaker detection for a project", "operationId": "audiobook_assign_speakers_api_v1_audiobook_projects__project_id__assign_speakers_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AudiobookAssignSpeakersRequest" }, { "type": "null" } ], "title": "Req" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/assign-speakers/status": { "get": { "tags": [ "Audiobook" ], "summary": "Poll speaker detection progress", "operationId": "audiobook_assign_speakers_status_api_v1_audiobook_projects__project_id__assign_speakers_status_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/assign-speakers/cancel": { "post": { "tags": [ "Audiobook" ], "summary": "Cancel the running speaker detection or dramatization", "operationId": "audiobook_cancel_assign_speakers_api_v1_audiobook_assign_speakers_cancel_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/audiobook/projects/{project_id}/assign-speakers/cancel": { "post": { "tags": [ "Audiobook" ], "summary": "Cancel this project's running speaker detection", "operationId": "audiobook_cancel_assign_speakers_project_api_v1_audiobook_projects__project_id__assign_speakers_cancel_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/segments/{segment_id}/identify": { "post": { "tags": [ "Audiobook" ], "summary": "Identify speakers and emotions for one segment", "operationId": "audiobook_identify_segment_api_v1_audiobook_projects__project_id__segments__segment_id__identify_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/design-cast": { "post": { "tags": [ "Audiobook" ], "summary": "Design and assign a voice for every uncast character", "operationId": "audiobook_design_cast_api_v1_audiobook_projects__project_id__design_cast_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AudiobookDesignCastRequest" }, { "type": "null" } ], "title": "Req" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/design-cast/status": { "get": { "tags": [ "Audiobook" ], "summary": "Poll voice design progress", "operationId": "audiobook_design_cast_status_api_v1_audiobook_projects__project_id__design_cast_status_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/design-cast/cancel": { "post": { "tags": [ "Audiobook" ], "summary": "Cancel the running voice design", "operationId": "audiobook_cancel_design_cast_api_v1_audiobook_design_cast_cancel_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/audiobook/projects/{project_id}/dramatize": { "post": { "tags": [ "Audiobook" ], "summary": "Start rewriting a project as a dramatized script", "operationId": "audiobook_dramatize_api_v1_audiobook_projects__project_id__dramatize_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiobookDramatizeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audiobook/projects/{project_id}/dramatize/status": { "get": { "tags": [ "Audiobook" ], "summary": "Poll dramatization progress", "operationId": "audiobook_dramatize_status_api_v1_audiobook_projects__project_id__dramatize_status_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects": { "get": { "tags": [ "Dubbing" ], "summary": "List dubbing projects", "operationId": "dubbing_list_projects_api_v1_dubbing_projects_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "Dubbing" ], "summary": "Create a dubbing project", "operationId": "dubbing_create_project_api_v1_dubbing_projects_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/translation-languages": { "get": { "tags": [ "Dubbing" ], "summary": "Languages a dub can translate into", "operationId": "dubbing_translation_languages_api_v1_dubbing_translation_languages_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/dubbing/projects/{project_id}": { "get": { "tags": [ "Dubbing" ], "summary": "Get a dubbing project", "operationId": "dubbing_get_project_api_v1_dubbing_projects__project_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Dubbing" ], "summary": "Delete a dubbing project", "operationId": "dubbing_delete_project_api_v1_dubbing_projects__project_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/speakers/{speaker_id}": { "put": { "tags": [ "Dubbing" ], "summary": "Assign a voice to a speaker", "operationId": "dubbing_set_speaker_voice_api_v1_dubbing_projects__project_id__speakers__speaker_id__put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "speaker_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Speaker Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingSpeakerVoiceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/speakers/{speaker_id}/label": { "put": { "tags": [ "Dubbing" ], "summary": "Rename a speaker", "operationId": "dubbing_rename_speaker_api_v1_dubbing_projects__project_id__speakers__speaker_id__label_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "speaker_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Speaker Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingRenameSpeakerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/speakers": { "post": { "tags": [ "Dubbing" ], "summary": "Add a speaker", "operationId": "dubbing_add_speaker_api_v1_dubbing_projects__project_id__speakers_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingAddSpeakerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/speakers/{speaker_id}/delete": { "post": { "tags": [ "Dubbing" ], "summary": "Remove a speaker, reassigning their segments", "operationId": "dubbing_delete_speaker_api_v1_dubbing_projects__project_id__speakers__speaker_id__delete_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "speaker_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Speaker Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingDeleteSpeakerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/segments/{segment_id}": { "put": { "tags": [ "Dubbing" ], "summary": "Update a segment", "operationId": "dubbing_update_segment_api_v1_dubbing_projects__project_id__segments__segment_id__put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingSegmentUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Dubbing" ], "summary": "Delete a segment", "description": "Remove one line from the dub. Run the project again to rebuild the mix without it.", "operationId": "dubbing_delete_segment_api_v1_dubbing_projects__project_id__segments__segment_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/run": { "post": { "tags": [ "Dubbing" ], "summary": "Run the auto-dub pipeline", "operationId": "dubbing_run_api_v1_dubbing_projects__project_id__run_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "lipsync", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Force lip sync on/off; defaults to the project's auto_lipsync setting", "title": "Lipsync" }, "description": "Force lip sync on/off; defaults to the project's auto_lipsync setting" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DubbingRunRequest" }, { "type": "null" } ], "title": "Req" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/cancel": { "post": { "tags": [ "Dubbing" ], "summary": "Stop a running dub", "description": "Asks the running pipeline to stop at its next stage boundary.", "operationId": "dubbing_cancel_api_v1_dubbing_projects__project_id__cancel_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/subtitle-params": { "put": { "tags": [ "Dubbing" ], "summary": "Save the subtitle style", "operationId": "dubbing_set_subtitle_params_api_v1_dubbing_projects__project_id__subtitle_params_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingSubtitleParamsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/glossary": { "put": { "tags": [ "Dubbing" ], "summary": "Save the glossary", "operationId": "dubbing_set_glossary_api_v1_dubbing_projects__project_id__glossary_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingGlossaryRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/export-options": { "put": { "tags": [ "Dubbing" ], "summary": "Save the export format", "operationId": "dubbing_set_export_options_api_v1_dubbing_projects__project_id__export_options_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingExportOptionsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/export": { "post": { "tags": [ "Dubbing" ], "summary": "Export the dubbed video", "description": "Writes the finished dub (subtitles burned in when they are on) into the\nproject's output folder and returns a download link for it. The desktop app\nasks where to save instead; both share dubbing.export.export_video.", "operationId": "dubbing_export_api_v1_dubbing_projects__project_id__export_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DubbingExportRequest" }, { "type": "null" } ], "title": "Req" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/lipsync": { "post": { "tags": [ "Dubbing" ], "summary": "Run lip sync on a finished dub", "operationId": "dubbing_lipsync_api_v1_dubbing_projects__project_id__lipsync_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/segments/{segment_id}/regenerate": { "post": { "tags": [ "Dubbing" ], "summary": "Regenerate one segment", "operationId": "dubbing_regenerate_api_v1_dubbing_projects__project_id__segments__segment_id__regenerate_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/segments/{segment_id}/source-edited": { "post": { "tags": [ "Dubbing" ], "summary": "Mark a segment's source text as edited since translation", "operationId": "dubbing_mark_source_edited_api_v1_dubbing_projects__project_id__segments__segment_id__source_edited_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Dubbing" ], "summary": "Clear a segment's source-edited mark", "operationId": "dubbing_clear_source_edited_api_v1_dubbing_projects__project_id__segments__segment_id__source_edited_delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/name": { "put": { "tags": [ "Dubbing" ], "summary": "Rename a dubbing project", "operationId": "dubbing_rename_project_api_v1_dubbing_projects__project_id__name_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/youtube": { "post": { "tags": [ "Dubbing" ], "summary": "Create a dubbing project from a YouTube URL", "operationId": "dubbing_create_project_from_youtube_api_v1_dubbing_projects_youtube_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DubbingYoutubeCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dubbing/projects/{project_id}/media": { "get": { "tags": [ "Dubbing" ], "summary": "Stream a project's video, segment clip, or speaker reference", "description": "Range-capable media for direct