VoiceStudio is the open-source, fully-local ElevenLabs alternative — voice cloning, voice design, video dubbing, dictation, transcription & audiobook creation in 646 languages.
Python aiaudiobookcudadubbingelevenlabs-alternativehuggingfacelocal-firstmlxomnivoice-studiospeech-to-texttext-to-speechtranscriptiontranslatettsvoice-aivoice-cloningvoice-generationvoicestudioworkflow
{
"components": {
"schemas": {
"AcceptRequest": {
"additionalProperties": false,
"properties": {
"accepted": {
"title": "Accepted",
"type": "boolean"
},
"fingerprint": {
"pattern": "^v2:[a-f0-9]{64}$",
"title": "Fingerprint",
"type": "string"
},
"repo_id": {
"maxLength": 200,
"minLength": 3,
"pattern": "^[A-Za-z0-9][\\w.-]*/[\\w.-]+$",
"title": "Repo Id",
"type": "string"
}
},
"required": [
"repo_id",
"fingerprint",
"accepted"
],
"title": "AcceptRequest",
"type": "object"
},
"AgentFitRequest": {
"description": "Revise only rendered lines that missed their exact timeline slot.",
"properties": {
"segments": {
"items": {
"$ref": "#/components/schemas/AgentFitSegment"
},
"title": "Segments",
"type": "array"
},
"target_lang": {
"title": "Target Lang",
"type": "string"
},
"translation_instructions": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Translation Instructions"
}
},
"required": [
"segments",
"target_lang"
],
"title": "AgentFitRequest",
"type": "object"
},
"AgentFitSegment": {
"description": "One rendered translation and its measured timing evidence.",
"properties": {
"context_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context After"
},
"context_before": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context Before"
},
"id": {
"title": "Id",
"type": "string"
},
"measured_seconds": {
"title": "Measured Seconds",
"type": "number"
},
"slot_seconds": {
"title": "Slot Seconds",
"type": "number"
},
"source_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Text"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"id",
"text",
"slot_seconds",
"measured_seconds"
],
"title": "AgentFitSegment",
"type": "object"
},
"ArgosPackRequest": {
"properties": {
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Id"
},
"source_lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Lang"
},
"target_langs": {
"items": {
"type": "string"
},
"maxItems": 32,
"minItems": 1,
"title": "Target Langs",
"type": "array"
}
},
"required": [
"target_langs"
],
"title": "ArgosPackRequest",
"type": "object"
},
"AttestationBody": {
"properties": {
"basis": {
"enum": [
"own_voice",
"speaker_permission"
],
"title": "Basis",
"type": "string"
}
},
"required": [
"basis"
],
"title": "AttestationBody",
"type": "object"
},
"AudiobookPlanRequest": {
"properties": {
"default_voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Voice"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "AudiobookPlanRequest",
"type": "object"
},
"AudiobookPreviewRequest": {
"properties": {
"chapter_index": {
"default": 0,
"title": "Chapter Index",
"type": "integer"
},
"class_temperature": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Class Temperature"
},
"default_voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Voice"
},
"emo_alpha": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Emo Alpha"
},
"emo_text": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"title": "Emo Text"
},
"emo_vector": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 8,
"minItems": 8,
"type": "array"
},
{
"type": "null"
}
],
"title": "Emo Vector"
},
"guidance_scale": {
"anyOf": [
{
"maximum": 20.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Guidance Scale"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"lexicon": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Lexicon"
},
"line_gap_ms": {
"default": 0,
"maximum": 5000.0,
"minimum": 0.0,
"title": "Line Gap Ms",
"type": "integer"
},
"num_step": {
"anyOf": [
{
"maximum": 512.0,
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Step"
},
"paragraph_gap_ms": {
"default": 0,
"maximum": 5000.0,
"minimum": 0.0,
"title": "Paragraph Gap Ms",
"type": "integer"
},
"position_temperature": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Position Temperature"
},
"postprocess_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Postprocess Output"
},
"seed": {
"anyOf": [
{
"maximum": 4294967295.0,
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"text": {
"title": "Text",
"type": "string"
},
"trim_edges": {
"default": false,
"title": "Trim Edges",
"type": "boolean"
},
"vary_repeats": {
"default": false,
"title": "Vary Repeats",
"type": "boolean"
},
"voice_map": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Voice Map"
}
},
"required": [
"text"
],
"title": "AudiobookPreviewRequest",
"type": "object"
},
"AudiobookRequest": {
"properties": {
"bitrate": {
"default": "128k",
"title": "Bitrate",
"type": "string"
},
"class_temperature": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Class Temperature"
},
"cover_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cover Path"
},
"default_voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Voice"
},
"emo_alpha": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Emo Alpha"
},
"emo_text": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"title": "Emo Text"
},
"emo_vector": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 8,
"minItems": 8,
"type": "array"
},
{
"type": "null"
}
],
"title": "Emo Vector"
},
"format": {
"default": "m4b",
"title": "Format",
"type": "string"
},
"guidance_scale": {
"anyOf": [
{
"maximum": 20.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Guidance Scale"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"lexicon": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Lexicon"
},
"line_gap_ms": {
"default": 0,
"maximum": 5000.0,
"minimum": 0.0,
"title": "Line Gap Ms",
"type": "integer"
},
"loudness": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Loudness"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
},
"num_step": {
"anyOf": [
{
"maximum": 512.0,
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Step"
},
"paragraph_gap_ms": {
"default": 0,
"maximum": 5000.0,
"minimum": 0.0,
"title": "Paragraph Gap Ms",
"type": "integer"
},
"position_temperature": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Position Temperature"
},
"postprocess_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Postprocess Output"
},
"seed": {
"anyOf": [
{
"maximum": 4294967295.0,
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"text": {
"title": "Text",
"type": "string"
},
"trim_edges": {
"default": false,
"title": "Trim Edges",
"type": "boolean"
},
"vary_repeats": {
"default": false,
"title": "Vary Repeats",
"type": "boolean"
},
"voice_map": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Voice Map"
}
},
"required": [
"text"
],
"title": "AudiobookRequest",
"type": "object"
},
"AutoExtractRequest": {
"properties": {
"max_terms": {
"default": 40,
"title": "Max Terms",
"type": "integer"
},
"segments": {
"description": "[{text: '...'}] \u2014 only text is read; other fields ignored.",
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Segments",
"type": "array"
},
"source_lang": {
"default": "en",
"title": "Source Lang",
"type": "string"
},
"target_lang": {
"title": "Target Lang",
"type": "string"
}
},
"required": [
"target_lang"
],
"title": "AutoExtractRequest",
"type": "object"
},
"Body_audiobook_cover_audiobook_cover_post": {
"properties": {
"cover": {
"contentMediaType": "application/octet-stream",
"title": "Cover",
"type": "string"
}
},
"required": [
"cover"
],
"title": "Body_audiobook_cover_audiobook_cover_post",
"type": "object"
},
"Body_audiobook_import_audiobook_import_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_audiobook_import_audiobook_import_post",
"type": "object"
},
"Body_clean_audio_clean_audio_post": {
"properties": {
"audio": {
"contentMediaType": "application/octet-stream",
"title": "Audio",
"type": "string"
}
},
"required": [
"audio"
],
"title": "Body_clean_audio_clean_audio_post",
"type": "object"
},
"Body_convert_speech_convert_post": {
"properties": {
"audio": {
"contentMediaType": "application/octet-stream",
"title": "Audio",
"type": "string"
},
"match_duration": {
"default": true,
"title": "Match Duration",
"type": "boolean"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
}
},
"required": [
"audio",
"profile_id"
],
"title": "Body_convert_speech_convert_post",
"type": "object"
},
"Body_create_profile_profiles_post": {
"properties": {
"image": {
"anyOf": [
{
"contentMediaType": "application/octet-stream",
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"instruct": {
"default": "",
"title": "Instruct",
"type": "string"
},
"kind": {
"default": "clone",
"title": "Kind",
"type": "string"
},
"language": {
"default": "Auto",
"title": "Language",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"personality": {
"default": "",
"title": "Personality",
"type": "string"
},
"ref_audio": {
"anyOf": [
{
"contentMediaType": "application/octet-stream",
"type": "string"
},
{
"type": "null"
}
],
"title": "Ref Audio"
},
"ref_text": {
"default": "",
"title": "Ref Text",
"type": "string"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"vd_states": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Vd States"
}
},
"required": [
"name"
],
"title": "Body_create_profile_profiles_post",
"type": "object"
},
"Body_create_transcription_v1_audio_transcriptions_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"description": "Audio file to transcribe",
"title": "File",
"type": "string"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Language of the input audio (ISO 639-1). Optional.",
"title": "Language"
},
"model": {
"default": "whisper-1",
"description": "ASR model. OpenAI ids ('whisper-1', 'gpt-4o-transcribe', 'gpt-4o-mini-transcribe') are served by the active engine; a VoiceStudio ASR engine id must name the active engine (400 otherwise).",
"title": "Model",
"type": "string"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional text to guide the model's style or continue a previous segment.",
"title": "Prompt"
},
"response_format": {
"default": "json",
"description": "Output format: json, text, verbose_json, srt, vtt.",
"title": "Response Format",
"type": "string"
},
"stream": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Streaming is not supported (400).",
"title": "Stream"
},
"temperature": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sampling temperature (0\u20131). Used by engines that support it.",
"title": "Temperature"
},
"timestamp_granularities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Timestamp Granularities"
},
"timestamp_granularities[]": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "'word' and/or 'segment' (verbose_json).",
"title": "Timestamp Granularities[]"
}
},
"required": [
"file"
],
"title": "Body_create_transcription_v1_audio_transcriptions_post",
"type": "object"
},
"Body_create_translation_v1_audio_translations_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"description": "Audio file to translate into English",
"title": "File",
"type": "string"
},
"model": {
"default": "whisper-1",
"description": "ASR model. OpenAI ids ('whisper-1', 'gpt-4o-transcribe', 'gpt-4o-mini-transcribe') are served by the active engine; a VoiceStudio ASR engine id must name the active engine (400 otherwise).",
"title": "Model",
"type": "string"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional text to guide the model's style.",
"title": "Prompt"
},
"response_format": {
"default": "json",
"description": "Output format: json, text, verbose_json, srt, vtt.",
"title": "Response Format",
"type": "string"
},
"temperature": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sampling temperature (0\u20131).",
"title": "Temperature"
}
},
"required": [
"file"
],
"title": "Body_create_translation_v1_audio_translations_post",
"type": "object"
},
"Body_detect_audio_watermark_watermark_detect_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_detect_audio_watermark_watermark_detect_post",
"type": "object"
},
"Body_dub_import_srt_dub_import_srt__job_id__post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_dub_import_srt_dub_import_srt__job_id__post",
"type": "object"
},
"Body_dub_upload_dub_upload_post": {
"properties": {
"input_type": {
"default": "video",
"title": "Input Type",
"type": "string"
},
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Id"
},
"source_lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Lang"
},
"video": {
"contentMediaType": "application/octet-stream",
"title": "Video",
"type": "string"
}
},
"required": [
"video"
],
"title": "Body_dub_upload_dub_upload_post",
"type": "object"
},
"Body_enqueue_batch_job_batch_enqueue_post": {
"properties": {
"langs": {
"default": "es",
"title": "Langs",
"type": "string"
},
"preserve_bg": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
},
"translation_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Translation Provider"
},
"video": {
"contentMediaType": "application/octet-stream",
"title": "Video",
"type": "string"
},
"voice_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voice Id"
}
},
"required": [
"video"
],
"title": "Body_enqueue_batch_job_batch_enqueue_post",
"type": "object"
},
"Body_generate_speech_generate_post": {
"properties": {
"class_temperature": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Class Temperature"
},
"crossfade_ms": {
"default": 50,
"maximum": 1000.0,
"minimum": 0.0,
"title": "Crossfade Ms",
"type": "integer"
},
"denoise": {
"default": true,
"title": "Denoise",
"type": "boolean"
},
"design_recipe": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Design Recipe"
},
"duration": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Duration"
},
"effect_preset": {
"default": "broadcast",
"title": "Effect Preset",
"type": "string"
},
"engine": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
},
"guidance_scale": {
"default": 2.0,
"title": "Guidance Scale",
"type": "number"
},
"instruct": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instruct"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"layer_penalty_factor": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Layer Penalty Factor"
},
"max_chunk_chars": {
"default": 800,
"minimum": 0.0,
"title": "Max Chunk Chars",
"type": "integer"
},
"num_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Step"
},
"position_temperature": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Position Temperature"
},
"postprocess_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Postprocess Output"
},
"preset_voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Preset Voice"
},
"profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Id"
},
"pronounce": {
"default": true,
"title": "Pronounce",
"type": "boolean"
},
"ref_audio": {
"anyOf": [
{
"contentMediaType": "application/octet-stream",
"type": "string"
},
{
"type": "null"
}
],
"title": "Ref Audio"
},
"ref_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ref Text"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"speed": {
"default": 1.0,
"title": "Speed",
"type": "number"
},
"stream": {
"default": false,
"title": "Stream",
"type": "boolean"
},
"t_shift": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "T Shift"
},
"text": {
"title": "Text",
"type": "string"
},
"wav_bits": {
"default": "16",
"enum": [
"16",
"24",
"32"
],
"title": "Wav Bits",
"type": "string"
}
},
"required": [
"text"
],
"title": "Body_generate_speech_generate_post",
"type": "object"
},
"Body_import_persona_personas_import_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_import_persona_personas_import_post",
"type": "object"
},
"Body_import_profile_marketplace_import_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"description": "A .omnivoice bundle file",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_import_profile_marketplace_import_post",
"type": "object"
},
"Body_inspect_persona_personas_inspect_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_inspect_persona_personas_inspect_post",
"type": "object"
},
"Body_lock_profile_profiles__profile_id__lock_post": {
"properties": {
"history_id": {
"title": "History Id",
"type": "string"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
}
},
"required": [
"history_id"
],
"title": "Body_lock_profile_profiles__profile_id__lock_post",
"type": "object"
},
"Body_normalize_workflow_speech_tools_normalize_speech_post": {
"properties": {
"audio": {
"contentMediaType": "application/octet-stream",
"title": "Audio",
"type": "string"
},
"target_dbfs": {
"default": -2.0,
"maximum": -1.0,
"minimum": -24.0,
"title": "Target Dbfs",
"type": "number"
}
},
"required": [
"audio"
],
"title": "Body_normalize_workflow_speech_tools_normalize_speech_post",
"type": "object"
},
"Body_preview_upload_preview_upload_post": {
"properties": {
"video": {
"contentMediaType": "application/octet-stream",
"title": "Video",
"type": "string"
}
},
"required": [
"video"
],
"title": "Body_preview_upload_preview_upload_post",
"type": "object"
},
"Body_record_consent_profiles__profile_id__consent_post": {
"properties": {
"consent_audio": {
"contentMediaType": "application/octet-stream",
"title": "Consent Audio",
"type": "string"
},
"consent_text": {
"title": "Consent Text",
"type": "string"
}
},
"required": [
"consent_audio",
"consent_text"
],
"title": "Body_record_consent_profiles__profile_id__consent_post",
"type": "object"
},
"Body_replace_profile_audio_profiles__profile_id__audio_put": {
"properties": {
"instruct": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instruct"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"personality": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Personality"
},
"ref_audio": {
"contentMediaType": "application/octet-stream",
"title": "Ref Audio",
"type": "string"
},
"ref_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ref Text"
}
},
"required": [
"ref_audio"
],
"title": "Body_replace_profile_audio_profiles__profile_id__audio_put",
"type": "object"
},
"Body_set_preview_gallery_archetypes_previews_put": {
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "Body_set_preview_gallery_archetypes_previews_put",
"type": "object"
},
"Body_stories_encode_stories_encode_post": {
"properties": {
"bitrate": {
"default": "192k",
"title": "Bitrate",
"type": "string"
},
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
},
"format": {
"default": "mp3",
"title": "Format",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_stories_encode_stories_encode_post",
"type": "object"
},
"Body_transcribe_audio_transcribe_post": {
"properties": {
"audio": {
"contentMediaType": "application/octet-stream",
"title": "Audio",
"type": "string"
},
"dictation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dictation"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mode"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model"
},
"refine": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Refine"
}
},
"required": [
"audio"
],
"title": "Body_transcribe_audio_transcribe_post",
"type": "object"
},
"Body_update_profile_image_profiles__profile_id__image_put": {
"properties": {
"image": {
"contentMediaType": "application/octet-stream",
"title": "Image",
"type": "string"
}
},
"required": [
"image"
],
"title": "Body_update_profile_image_profiles__profile_id__image_put",
"type": "object"
},
"Body_upload_voice_clip_gallery_upload_post": {
"properties": {
"audio": {
"contentMediaType": "application/octet-stream",
"title": "Audio",
"type": "string"
},
"category": {
"default": "import",
"title": "Category",
"type": "string"
},
"character": {
"default": "",
"title": "Character",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"audio"
],
"title": "Body_upload_voice_clip_gallery_upload_post",
"type": "object"
},
"ChoicesBody": {
"properties": {
"choices": {
"additionalProperties": {
"type": "boolean"
},
"title": "Choices",
"type": "object"
},
"new_device": {
"default": false,
"title": "New Device",
"type": "boolean"
},
"remove_from_cloud": {
"items": {
"type": "string"
},
"title": "Remove From Cloud",
"type": "array"
}
},
"title": "ChoicesBody",
"type": "object"
},
"CleanupSegmentsRequest": {
"description": "The editor's current segments; without them the job's stored copy is\ncleaned, which misses every edit made since transcription.",
"properties": {
"segments": {
"items": {
"additionalProperties": true,
"type": "object"
},
"maxItems": 20000,
"title": "Segments",
"type": "array"
}
},
"required": [
"segments"
],
"title": "CleanupSegmentsRequest",
"type": "object"
},
"CommitRequest": {
"additionalProperties": false,
"properties": {
"acknowledged": {
"title": "Acknowledged",
"type": "boolean"
},
"acknowledged_document_ids": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Acknowledged Document Ids",
"type": "array"
},
"plan_digest": {
"pattern": "^[a-f0-9]{64}$",
"title": "Plan Digest",
"type": "string"
},
"plan_id": {
"pattern": "^[a-f0-9]{32}$",
"title": "Plan Id",
"type": "string"
},
"target": {
"const": "local",
"default": "local",
"title": "Target",
"type": "string"
}
},
"required": [
"plan_id",
"plan_digest",
"acknowledged_document_ids",
"acknowledged"
],
"title": "CommitRequest",
"type": "object"
},
"CustomPathRequest": {
"properties": {
"authorization": {
"title": "Authorization",
"type": "string"
}
},
"required": [
"authorization"
],
"title": "CustomPathRequest",
"type": "object"
},
"DescribeRequest": {
"properties": {
"description": {
"default": "",
"maxLength": 2000,
"title": "Description",
"type": "string"
}
},
"title": "DescribeRequest",
"type": "object"
},
"DeviceInfo": {
"additionalProperties": true,
"description": "GPU/system device info from preflight.",
"properties": {
"arch": {
"title": "Arch",
"type": "string"
},
"disk_free_gb": {
"default": 0.0,
"title": "Disk Free Gb",
"type": "number"
},
"gpu_available": {
"default": false,
"title": "Gpu Available",
"type": "boolean"
},
"gpu_backend": {
"default": "cpu",
"title": "Gpu Backend",
"type": "string"
},
"gpu_device_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gpu Device Name"
},
"gpu_driver": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gpu Driver"
},
"gpu_family": {
"default": "cpu",
"title": "Gpu Family",
"type": "string"
},
"gpu_vendor": {
"default": "none",
"title": "Gpu Vendor",
"type": "string"
},
"os": {
"title": "Os",
"type": "string"
},
"ram_gb": {
"default": 0.0,
"title": "Ram Gb",
"type": "number"
},
"vram_gb": {
"default": 0.0,
"title": "Vram Gb",
"type": "number"
}
},
"required": [
"os",
"arch"
],
"title": "DeviceInfo",
"type": "object"
},
"DiarisationSelection": {
"properties": {
"engine_id": {
"title": "Engine Id",
"type": "string"
}
},
"required": [
"engine_id"
],
"title": "DiarisationSelection",
"type": "object"
},
"DictationPrefsUpdate": {
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled"
},
"mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mode"
},
"model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
}
},
"title": "DictationPrefsUpdate",
"type": "object"
},
"DirectionReq": {
"properties": {
"text": {
"description": "Natural-language direction, e.g. 'urgent and surprised'",
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "DirectionReq",
"type": "object"
},
"DubIngestUrlRequest": {
"properties": {
"cookie_file": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cookie File"
},
"fetch_subs": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Fetch Subs"
},
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Id"
},
"source_lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Lang"
},
"sub_langs": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sub Langs"
},
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "DubIngestUrlRequest",
"type": "object"
},
"DubSegment": {
"properties": {
"cue_source_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cue Source Id"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction"
},
"effect_preset": {
"default": "broadcast",
"title": "Effect Preset",
"type": "string"
},
"end": {
"title": "End",
"type": "number"
},
"gain": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Gain"
},
"instruct": {
"default": "",
"title": "Instruct",
"type": "string"
},
"profile_id": {
"default": "",
"title": "Profile Id",
"type": "string"
},
"speed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Speed"
},
"start": {
"title": "Start",
"type": "number"
},
"target_lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Lang"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"start",
"end",
"text"
],
"title": "DubSegment",
"type": "object"
},
"EffectPresetEntry": {
"additionalProperties": true,
"description": "One DSP effect preset.",
"properties": {
"description": {
"title": "Description",
"type": "string"
},
"icon": {
"title": "Icon",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
}
},
"required": [
"id",
"label",
"icon",
"description"
],
"title": "EffectPresetEntry",
"type": "object"
},
"EffectPresetsResponse": {
"description": "GET /engines/effects/presets",
"properties": {
"presets": {
"items": {
"$ref": "#/components/schemas/EffectPresetEntry"
},
"title": "Presets",
"type": "array"
}
},
"title": "EffectPresetsResponse",
"type": "object"
},
"EndpointCapability": {
"properties": {
"method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Method"
},
"path": {
"title": "Path",
"type": "string"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Protocol"
},
"transport": {
"enum": [
"http",
"websocket",
"mcp-streamable-http",
"mcp-stdio"
],
"title": "Transport",
"type": "string"
}
},
"required": [
"path",
"transport"
],
"title": "EndpointCapability",
"type": "object"
},
"ExportRecordRequest": {
"properties": {
"destination_path": {
"default": "~/Downloads",
"title": "Destination Path",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"mode": {
"default": "file",
"title": "Mode",
"type": "string"
}
},
"required": [
"filename"
],
"title": "ExportRecordRequest",
"type": "object"
},
"ExportRequest": {
"properties": {
"authorization": {
"title": "Authorization",
"type": "string"
},
"mode": {
"default": "history",
"title": "Mode",
"type": "string"
},
"source_filename": {
"title": "Source Filename",
"type": "string"
}
},
"required": [
"source_filename",
"authorization"
],
"title": "ExportRequest",
"type": "object"
},
"FitOptions": {
"description": "Optional knob overrides for the `smart_fit` timing strategy.\n\nAll fields default to None \u2014 the server fills in the canonical\ndefaults (services.fit_planner.FitParams) so old clients and sparse\npayloads behave identically to a fully-populated default payload.",
"properties": {
"allow_video_retime": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Video Retime"
},
"audio_rate_cap": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Audio Rate Cap"
},
"gap_guard_s": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Gap Guard S"
},
"max_audio_only_rate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Max Audio Only Rate"
},
"min_audio_rate": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.5,
"type": "number"
},
{
"type": "null"
}
],
"title": "Min Audio Rate"
},
"video_slow_cap": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Video Slow Cap"
}
},
"title": "FitOptions",
"type": "object"
},
"GlossaryTerm": {
"properties": {
"note": {
"default": "",
"title": "Note",
"type": "string"
},
"source": {
"title": "Source",
"type": "string"
},
"target": {
"title": "Target",
"type": "string"
}
},
"required": [
"source",
"target"
],
"title": "GlossaryTerm",
"type": "object"
},
"GlossaryTermUpdate": {
"properties": {
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target"
}
},
"title": "GlossaryTermUpdate",
"type": "object"
},
"GpuRouting": {
"additionalProperties": true,
"description": "Routing verdict for the active TTS engine on THIS host (#21).\n\nDistinct from the per-engine `routing_*` keys in `/engines`: this is the\nsingle verdict for the *currently-selected* engine, surfaced in preflight +\ndiagnose so the user hears about a CPU fallback / unavailable GPU before a\nslow or failed synth \u2014 no silent CPU fallback.",
"properties": {
"effective_device": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Effective Device"
},
"engine": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
},
"host_family": {
"default": "cpu",
"title": "Host Family",
"type": "string"
},
"routing_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Routing Reason"
},
"routing_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Routing Status"
},
"vram_gb": {
"default": 0.0,
"title": "Vram Gb",
"type": "number"
}
},
"title": "GpuRouting",
"type": "object"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
},
"IncrementalReq": {
"properties": {
"lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lang"
},
"segments": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Segments",
"type": "array"
},
"stored_hashes": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Stored Hashes"
},
"voice_match": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voice Match"
}
},
"required": [
"segments"
],
"title": "IncrementalReq",
"type": "object"
},
"InstallModelRequest": {
"properties": {
"repo_id": {
"title": "Repo Id",
"type": "string"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target"
}
},
"required": [
"repo_id"
],
"title": "InstallModelRequest",
"type": "object"
},
"LocalValue": {
"properties": {
"key": {
"title": "Key",
"type": "string"
},
"seen_seq": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seen Seq"
},
"value": {
"title": "Value"
}
},
"required": [
"key"
],
"title": "LocalValue",
"type": "object"
},
"LongformChapter": {
"properties": {
"spans": {
"default": [],
"items": {
"$ref": "#/components/schemas/LongformSpan"
},
"title": "Spans",
"type": "array"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
}
},
"title": "LongformChapter",
"type": "object"
},
"LongformRenderRequest": {
"properties": {
"bitrate": {
"default": "128k",
"title": "Bitrate",
"type": "string"
},
"chapters": {
"default": [],
"items": {
"$ref": "#/components/schemas/LongformChapter"
},
"title": "Chapters",
"type": "array"
},
"class_temperature": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Class Temperature"
},
"cover_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cover Path"
},
"default_voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Voice"
},
"emo_alpha": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Emo Alpha"
},
"emo_text": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"title": "Emo Text"
},
"emo_vector": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 8,
"minItems": 8,
"type": "array"
},
{
"type": "null"
}
],
"title": "Emo Vector"
},
"format": {
"default": "m4b",
"title": "Format",
"type": "string"
},
"guidance_scale": {
"anyOf": [
{
"maximum": 20.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Guidance Scale"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"lexicon": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Lexicon"
},
"line_gap_ms": {
"default": 0,
"maximum": 5000.0,
"minimum": 0.0,
"title": "Line Gap Ms",
"type": "integer"
},
"loudness": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Loudness"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
},
"num_step": {
"anyOf": [
{
"maximum": 512.0,
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Step"
},
"paragraph_gap_ms": {
"default": 0,
"maximum": 5000.0,
"minimum": 0.0,
"title": "Paragraph Gap Ms",
"type": "integer"
},
"position_temperature": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Position Temperature"
},
"postprocess_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Postprocess Output"
},
"seed": {
"anyOf": [
{
"maximum": 4294967295.0,
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed"
},
"trim_edges": {
"default": false,
"title": "Trim Edges",
"type": "boolean"
},
"vary_repeats": {
"default": false,
"title": "Vary Repeats",
"type": "boolean"
},
"voice_map": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Voice Map"
}
},
"title": "LongformRenderRequest",
"type": "object"
},
"LongformSpan": {
"properties": {
"join": {
"anyOf": [
{
"enum": [
"continue",
"paragraph"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Join"
},
"pause_ms_after": {
"default": 0,
"title": "Pause Ms After",
"type": "integer"
},
"speed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Speed"
},
"text": {
"title": "Text",
"type": "string"
},
"voice_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voice Id"
}
},
"required": [
"text"
],
"title": "LongformSpan",
"type": "object"
},
"MissingModel": {
"properties": {
"label": {
"title": "Label",
"type": "string"
},
"repo_id": {
"title": "Repo Id",
"type": "string"
}
},
"required": [
"repo_id",
"label"
],
"title": "MissingModel",
"type": "object"
},
"ModelStatusResponse": {
"additionalProperties": true,
"description": "GET /model/status",
"properties": {
"checkpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Checkpoint"
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Human-readable detail of current loading phase",
"title": "Detail"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Error message if loading failed",
"title": "Error"
},
"loaded_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Loaded At"
},
"status": {
"description": "idle | loading | ready",
"title": "Status",
"type": "string"
},
"sub_stage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Current TTS loading sub-stage: importing | loading_weights | compiling | ready | error",
"title": "Sub Stage"
}
},
"required": [
"status"
],
"title": "ModelStatusResponse",
"type": "object"
},
"ParseSubtitleTextRequest": {
"description": "Raw pasted subtitle text (SRT/VTT-ish) to be parsed into timed cues.\n\nUsed by the \"paste translation from an external source\" flow: the user\npastes what ChatGPT/DeepL/a human gave them and the client needs the\nSAME lenient cue parsing the .srt import path uses \u2014 parsing it here\nkeeps `services.srt_parser` the single source of truth instead of\ngrowing a second, subtly-different implementation in JavaScript.",
"properties": {
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "ParseSubtitleTextRequest",
"type": "object"
},
"PreflightCheck": {
"additionalProperties": true,
"description": "One check in the preflight report.",
"properties": {
"detail": {
"default": "",
"title": "Detail",
"type": "string"
},
"fix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fix"
},
"id": {
"title": "Id",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"status": {
"description": "pass | warn | fail",
"title": "Status",
"type": "string"
}
},
"required": [
"id",
"label",
"status"
],
"title": "PreflightCheck",
"type": "object"
},
"PreflightResponse": {
"description": "GET /setup/preflight",
"properties": {
"checks": {
"items": {
"$ref": "#/components/schemas/PreflightCheck"
},
"title": "Checks",
"type": "array"
},
"device": {
"$ref": "#/components/schemas/DeviceInfo"
},
"gpu_routing": {
"anyOf": [
{
"$ref": "#/components/schemas/GpuRouting"
},
{
"type": "null"
}
]
},
"has_warnings": {
"default": false,
"title": "Has Warnings",
"type": "boolean"
},
"media_tools": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Media Tools"
},
"ok": {
"title": "Ok",
"type": "boolean"
}
},
"required": [
"ok",
"device"
],
"title": "PreflightResponse",
"type": "object"
},
"PrepareRequest": {
"additionalProperties": false,
"properties": {
"repo_id": {
"maxLength": 200,
"minLength": 3,
"title": "Repo Id",
"type": "string"
},
"target": {
"default": "local",
"maxLength": 200,
"title": "Target",
"type": "string"
}
},
"required": [
"repo_id"
],
"title": "PrepareRequest",
"type": "object"
},
"ProbeReq": {
"properties": {
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "ProbeReq",
"type": "object"
},
"ProfileUpdate": {
"properties": {
"instruct": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instruct"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"personality": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Personality"
},
"ref_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ref Text"
}
},
"title": "ProfileUpdate",
"type": "object"
},
"ProjectRenameRequest": {
"properties": {
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "ProjectRenameRequest",
"type": "object"
},
"ProjectSaveRequest": {
"properties": {
"audio_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Audio Path"
},
"duration": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Duration"
},
"name": {
"title": "Name",
"type": "string"
},
"state": {
"additionalProperties": true,
"title": "State",
"type": "object"
},
"video_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Video Path"
}
},
"required": [
"name",
"state"
],
"title": "ProjectSaveRequest",
"type": "object"
},
"PronEntry": {
"properties": {
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"language": {
"default": "*",
"title": "Language",
"type": "string"
},
"replacement": {
"default": "",
"title": "Replacement",
"type": "string"
},
"term": {
"title": "Term",
"type": "string"
},
"type": {
"default": "respelling",
"title": "Type",
"type": "string"
}
},
"required": [
"term"
],
"title": "PronEntry",
"type": "object"
},
"PronEntryUpdate": {
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"replacement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replacement"
},
"term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Term"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
}
},
"title": "PronEntryUpdate",
"type": "object"
},
"PronImportRequest": {
"properties": {
"entries": {
"items": {
"$ref": "#/components/schemas/PronEntry"
},
"title": "Entries",
"type": "array"
},
"replace": {
"default": false,
"title": "Replace",
"type": "boolean"
}
},
"required": [
"entries"
],
"title": "PronImportRequest",
"type": "object"
},
"PronTestRequest": {
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "PronTestRequest",
"type": "object"
},
"ProsodyMirrorRequest": {
"description": "Segments as the editor currently holds them: splits, merges and timing\nedits are client-side until generation, so the job's stored copy is stale.",
"properties": {
"segments": {
"items": {
"$ref": "#/components/schemas/ProsodyMirrorSegment"
},
"maxItems": 20000,
"minItems": 1,
"title": "Segments",
"type": "array"
}
},
"required": [
"segments"
],
"title": "ProsodyMirrorRequest",
"type": "object"
},
"ProsodyMirrorSegment": {
"properties": {
"end": {
"minimum": 0.0,
"title": "End",
"type": "number"
},
"id": {
"maxLength": 128,
"minLength": 1,
"title": "Id",
"type": "string"
},
"speaker_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Speaker Id"
},
"start": {
"minimum": 0.0,
"title": "Start",
"type": "number"
}
},
"required": [
"id",
"start",
"end"
],
"title": "ProsodyMirrorSegment",
"type": "object"
},
"RateFitReq": {
"properties": {
"slot_seconds": {
"title": "Slot Seconds",
"type": "number"
},
"source_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Text"
},
"target_lang": {
"title": "Target Lang",
"type": "string"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"text",
"slot_seconds",
"target_lang"
],
"title": "RateFitReq",
"type": "object"
},
"RevealRequest": {
"properties": {
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "RevealRequest",
"type": "object"
},
"RevokeRequest": {
"additionalProperties": false,
"properties": {
"repo_id": {
"maxLength": 200,
"minLength": 3,
"pattern": "^[A-Za-z0-9][\\w.-]*/[\\w.-]+$",
"title": "Repo Id",
"type": "string"
}
},
"required": [
"repo_id"
],
"title": "RevokeRequest",
"type": "object"
},
"SegmentPreviewRequest": {
"properties": {
"duration": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Duration"
},
"instruct": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instruct"
},
"language": {
"default": "Auto",
"title": "Language",
"type": "string"
},
"profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Id"
},
"segment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Segment Id"
},
"speed": {
"default": 1.0,
"title": "Speed",
"type": "number"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "SegmentPreviewRequest",
"type": "object"
},
"SelectEngineRequest": {
"properties": {
"backend_id": {
"title": "Backend Id",
"type": "string"
},
"family": {
"title": "Family",
"type": "string"
},
"model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
}
},
"required": [
"family",
"backend_id"
],
"title": "SelectEngineRequest",
"type": "object"
},
"SelectEngineResponse": {
"properties": {
"active": {
"title": "Active",
"type": "string"
},
"effective_device": {
"default": "cpu",
"title": "Effective Device",
"type": "string"
},
"env_override": {
"title": "Env Override",
"type": "boolean"
},
"family": {
"title": "Family",
"type": "string"
},
"routing_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Routing Reason"
},
"routing_status": {
"default": "cpu_only",
"title": "Routing Status",
"type": "string"
}
},
"required": [
"family",
"active",
"env_override"
],
"title": "SelectEngineResponse",
"type": "object"
},
"SelfTestResponse": {
"properties": {
"audio_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Audio Seconds"
},
"duration_ms": {
"title": "Duration Ms",
"type": "number"
},
"id": {
"title": "Id",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"num_samples": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Samples"
},
"ok": {
"title": "Ok",
"type": "boolean"
},
"sample_rate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Sample Rate"
},
"timed_out": {
"default": false,
"title": "Timed Out",
"type": "boolean"
}
},
"required": [
"id",
"ok",
"message",
"duration_ms"
],
"title": "SelfTestResponse",
"type": "object"
},
"SessionRequest": {
"properties": {
"transport": {
"enum": [
"cookie",
"bearer"
],
"title": "Transport",
"type": "string"
}
},
"required": [
"transport"
],
"title": "SessionRequest",
"type": "object"
},
"SetupStatusResponse": {
"description": "GET /setup/status",
"properties": {
"disk_free_gb": {
"title": "Disk Free Gb",
"type": "number"
},
"enough_disk": {
"default": true,
"title": "Enough Disk",
"type": "boolean"
},
"hf_cache_dir": {
"title": "Hf Cache Dir",
"type": "string"
},
"min_free_gb": {
"default": 10,
"title": "Min Free Gb",
"type": "integer"
},
"missing": {
"items": {
"$ref": "#/components/schemas/MissingModel"
},
"title": "Missing",
"type": "array"
},
"models_ready": {
"title": "Models Ready",
"type": "boolean"
}
},
"required": [
"models_ready",
"hf_cache_dir",
"disk_free_gb"
],
"title": "SetupStatusResponse",
"type": "object"
},
"SpeechAuthCapabilities": {
"properties": {
"browser_session_endpoint": {
"default": "/api/auth/session",
"title": "Browser Session Endpoint",
"type": "string"
},
"header": {
"default": "Authorization: Bearer <OMNIVOICE_API_KEY>",
"title": "Header",
"type": "string"
},
"loopback": {
"const": "none",
"default": "none",
"title": "Loopback",
"type": "string"
},
"remote": {
"const": "bearer",
"default": "bearer",
"title": "Remote",
"type": "string"
},
"websocket_ticket_endpoint": {
"default": "/api/auth/ws-ticket",
"title": "Websocket Ticket Endpoint",
"type": "string"
},
"websocket_ticket_query_parameter": {
"const": "ws_ticket",
"default": "ws_ticket",
"title": "Websocket Ticket Query Parameter",
"type": "string"
}
},
"title": "SpeechAuthCapabilities",
"type": "object"
},
"SpeechCapabilities": {
"properties": {
"authentication": {
"$ref": "#/components/schemas/SpeechAuthCapabilities"
},
"endpoints": {
"additionalProperties": {
"$ref": "#/components/schemas/EndpointCapability"
},
"title": "Endpoints",
"type": "object"
},
"features": {
"$ref": "#/components/schemas/SpeechFeatureCapabilities"
},
"local_first": {
"default": true,
"title": "Local First",
"type": "boolean"
},
"protocol": {
"const": "voicestudio.speech.v1",
"default": "voicestudio.speech.v1",
"title": "Protocol",
"type": "string"
},
"protocol_version": {
"const": "1.0",
"default": "1.0",
"title": "Protocol Version",
"type": "string"
},
"schema": {
"const": "voicestudio.speech-capabilities",
"default": "voicestudio.speech-capabilities",
"title": "Schema",
"type": "string"
},
"service": {
"default": "VoiceStudio",
"title": "Service",
"type": "string"
},
"service_version": {
"default": "0.0.0",
"title": "Service Version",
"type": "string"
},
"stream_input": {
"$ref": "#/components/schemas/StreamInputCapability"
},
"stream_output": {
"$ref": "#/components/schemas/StreamOutputCapability"
}
},
"required": [
"endpoints",
"stream_input",
"stream_output",
"features",
"authentication"
],
"title": "SpeechCapabilities",
"type": "object"
},
"SpeechFeatureCapabilities": {
"properties": {
"acoustic_echo_cancellation": {
"default": true,
"title": "Acoustic Echo Cancellation",
"type": "boolean"
},
"batch_transcription": {
"default": true,
"title": "Batch Transcription",
"type": "boolean"
},
"local_refinement": {
"default": true,
"title": "Local Refinement",
"type": "boolean"
},
"native_dictation_control": {
"default": false,
"title": "Native Dictation Control",
"type": "boolean"
},
"partial_transcripts": {
"default": true,
"title": "Partial Transcripts",
"type": "boolean"
},
"session_summary": {
"default": true,
"title": "Session Summary",
"type": "boolean"
},
"streaming_transcription": {
"default": true,
"title": "Streaming Transcription",
"type": "boolean"
},
"utterance_finals": {
"default": true,
"title": "Utterance Finals",
"type": "boolean"
},
"word_timestamps": {
"default": true,
"title": "Word Timestamps",
"type": "boolean"
}
},
"title": "SpeechFeatureCapabilities",
"type": "object"
},
"SpeechRequest": {
"description": "POST /v1/audio/speech \u2014 mirrors OpenAI's CreateSpeechRequest.",
"properties": {
"chunk_duration": {
"anyOf": [
{
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "OmniVoice GGUF extension: long-form internal chunk duration.",
"title": "Chunk Duration"
},
"chunk_threshold": {
"anyOf": [
{
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "OmniVoice GGUF extension: long-form internal chunk threshold.",
"title": "Chunk Threshold"
},
"denoise": {
"default": true,
"description": "VoiceStudio extension: prepend denoise control when supported.",
"title": "Denoise",
"type": "boolean"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Voice description for voice design (VoxCPM2 only). E.g. 'young female, warm tone, slight British accent'.",
"title": "Description"
},
"duration": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "VoiceStudio extension: target output duration in seconds.",
"title": "Duration"
},
"guidance_scale": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"maximum": 20.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "VoiceStudio extension: classifier-free guidance scale (app default 2.0).",
"title": "Guidance Scale"
},
"input": {
"description": "The text to synthesize. Max 4096 characters.",
"maxLength": 4096,
"title": "Input",
"type": "string"
},
"instruct": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Style instruction for the TTS engine.",
"title": "Instruct"
},
"instructions": {
"anyOf": [
{
"maxLength": 4096,
"type": "string"
},
{
"type": "null"
}
],
"description": "OpenAI's voice-style instructions, forwarded as the engine's style instruction (OmniVoice keeps only its voice-design tags). VoiceStudio's `instruct` wins when both are sent.",
"title": "Instructions"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Language code (ISO 639-1)",
"title": "Language"
},
"model": {
"default": "omnivoice",
"description": "TTS model to use. Maps to VoiceStudio engine IDs: 'omnivoice', 'voxcpm2', 'cosyvoice', 'mlx-audio', 'kittentts', 'moss-tts-nano'. OpenAI model ids ('tts-1', 'tts-1-hd', 'gpt-4o-mini-tts', dated snapshots) are aliases for the active engine.",
"title": "Model",
"type": "string"
},
"num_step": {
"anyOf": [
{
"maximum": 128.0,
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"description": "VoiceStudio extension: iterative unmasking steps (app default 16; 32 = the model's documented quality preset).",
"title": "Num Step"
},
"preprocess_prompt": {
"default": true,
"description": "VoiceStudio extension: trim/preprocess reference prompt when supported.",
"title": "Preprocess Prompt",
"type": "boolean"
},
"response_format": {
"default": "mp3",
"description": "Audio output format. `pcm` is raw 24 kHz 16-bit little-endian mono.",
"enum": [
"mp3",
"opus",
"aac",
"flac",
"wav",
"pcm"
],
"title": "Response Format",
"type": "string"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "VoiceStudio extension: deterministic sampling seed.",
"title": "Seed"
},
"speed": {
"default": 1.0,
"description": "Speed of the generated audio (0.25 to 4.0).",
"maximum": 4.0,
"minimum": 0.25,
"title": "Speed",
"type": "number"
},
"stream_format": {
"anyOf": [
{
"enum": [
"audio",
"sse"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "'audio' streams raw audio bytes (the default); 'sse' streams `speech.audio.delta` / `speech.audio.done` server-sent events.",
"title": "Stream Format"
},
"voice": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": true,
"type": "object"
}
],
"default": "default",
"description": "Voice to use. For VoiceStudio: pass a voice profile ID, a voice profile name (case-insensitive; an ID wins, and a name shared by several profiles is a 409 listing their IDs), 'default', or a KittenTTS preset name (also accepted as OpenAI's {\"id\": ...} object). OpenAI voice names (alloy, ash, ballad, coral, echo, fable, nova, onyx, sage, shimmer, verse, marin, cedar) are accepted and mapped to the engine default.",
"title": "Voice"
}
},
"required": [
"input"
],
"title": "SpeechRequest",
"type": "object"
},
"StreamInputCapability": {
"properties": {
"default_format": {
"title": "Default Format",
"type": "string"
},
"end_control": {
"additionalProperties": {
"type": "string"
},
"title": "End Control",
"type": "object"
},
"formats": {
"items": {
"type": "string"
},
"title": "Formats",
"type": "array"
},
"framing": {
"const": "binary",
"default": "binary",
"title": "Framing",
"type": "string"
},
"sample_rate_query": {
"default": "sr",
"title": "Sample Rate Query",
"type": "string"
}
},
"required": [
"formats",
"default_format",
"end_control"
],
"title": "StreamInputCapability",
"type": "object"
},
"StreamOutputCapability": {
"properties": {
"events": {
"items": {
"type": "string"
},
"title": "Events",
"type": "array"
},
"final_kinds": {
"items": {
"type": "string"
},
"title": "Final Kinds",
"type": "array"
},
"framing": {
"const": "json",
"default": "json",
"title": "Framing",
"type": "string"
}
},
"required": [
"events",
"final_kinds"
],
"title": "StreamOutputCapability",
"type": "object"
},
"SysinfoResponse": {
"additionalProperties": true,
"description": "GET /sysinfo",
"properties": {
"cpu": {
"description": "CPU usage percentage (0\u2013100)",
"title": "Cpu",
"type": "number"
},
"cpu_frequency_ghz": {
"default": 0.0,
"title": "Cpu Frequency Ghz",
"type": "number"
},
"cpu_logical_cores": {
"default": 0,
"title": "Cpu Logical Cores",
"type": "integer"
},
"cpu_model": {
"default": "",
"title": "Cpu Model",
"type": "string"
},
"cpu_physical_cores": {
"default": 0,
"title": "Cpu Physical Cores",
"type": "integer"
},
"gpu_active": {
"default": false,
"description": "Whether a GPU is actively used",
"title": "Gpu Active",
"type": "boolean"
},
"gpu_name": {
"default": "",
"title": "Gpu Name",
"type": "string"
},
"gpu_utilization": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Gpu Utilization"
},
"ram": {
"description": "Used RAM in GiB",
"title": "Ram",
"type": "number"
},
"total_ram": {
"description": "Total RAM in GiB",
"title": "Total Ram",
"type": "number"
},
"total_vram": {
"default": 0.0,
"description": "Total VRAM in GiB when reported by the runtime",
"title": "Total Vram",
"type": "number"
},
"vram": {
"default": 0.0,
"description": "Used VRAM in GiB",
"title": "Vram",
"type": "number"
}
},
"required": [
"cpu",
"ram",
"total_ram"
],
"title": "SysinfoResponse",
"type": "object"
},
"SystemInfoResponse": {
"additionalProperties": true,
"description": "GET /system/info",
"properties": {
"app_version": {
"default": "",
"title": "App Version",
"type": "string"
},
"arch": {
"default": "",
"title": "Arch",
"type": "string"
},
"asr_model": {
"default": "unknown",
"title": "Asr Model",
"type": "string"
},
"backend_port": {
"default": 3900,
"title": "Backend Port",
"type": "integer"
},
"code_fingerprint": {
"default": "",
"title": "Code Fingerprint",
"type": "string"
},
"cpu_count": {
"default": 0,
"title": "Cpu Count",
"type": "integer"
},
"cpu_generate_timeout_s": {
"default": 600.0,
"title": "Cpu Generate Timeout S",
"type": "number"
},
"cpu_generate_timeout_shadowed": {
"default": false,
"title": "Cpu Generate Timeout Shadowed",
"type": "boolean"
},
"cpu_model": {
"default": "",
"title": "Cpu Model",
"type": "string"
},
"crash_log_path": {
"title": "Crash Log Path",
"type": "string"
},
"data_dir": {
"title": "Data Dir",
"type": "string"
},
"device": {
"default": "cpu",
"title": "Device",
"type": "string"
},
"disk_free_gb": {
"default": 0.0,
"title": "Disk Free Gb",
"type": "number"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
},
"fast_download": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Fast Download"
},
"ffmpeg_ok": {
"default": false,
"title": "Ffmpeg Ok",
"type": "boolean"
},
"ffmpeg_path": {
"default": "",
"title": "Ffmpeg Path",
"type": "string"
},
"generate_timeout_s": {
"default": 300.0,
"title": "Generate Timeout S",
"type": "number"
},
"generate_timeout_shadowed": {
"default": false,
"title": "Generate Timeout Shadowed",
"type": "boolean"
},
"gpu_name": {
"default": "",
"title": "Gpu Name",
"type": "string"
},
"has_hf_token": {
"default": false,
"title": "Has Hf Token",
"type": "boolean"
},
"idle_timeout_seconds": {
"title": "Idle Timeout Seconds",
"type": "integer"
},
"lan_addresses": {
"default": [],
"items": {
"type": "string"
},
"title": "Lan Addresses",
"type": "array"
},
"model_checkpoint": {
"default": "unknown",
"title": "Model Checkpoint",
"type": "string"
},
"os_version": {
"default": "",
"title": "Os Version",
"type": "string"
},
"outputs_dir": {
"title": "Outputs Dir",
"type": "string"
},
"pin_required": {
"default": false,
"title": "Pin Required",
"type": "boolean"
},
"platform": {
"default": "",
"title": "Platform",
"type": "string"
},
"proxy_url": {
"default": "",
"title": "Proxy Url",
"type": "string"
},
"python": {
"default": "",
"title": "Python",
"type": "string"
},
"ram_total_gb": {
"default": 0.0,
"title": "Ram Total Gb",
"type": "number"
},
"share_enabled": {
"default": false,
"title": "Share Enabled",
"type": "boolean"
},
"share_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Share Port"
},
"share_port_base": {
"default": 3901,
"title": "Share Port Base",
"type": "integer"
},
"translate_provider": {
"default": "unknown",
"title": "Translate Provider",
"type": "string"
},
"ui_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 3901,
"title": "Ui Port"
},
"vram_total_gb": {
"default": 0.0,
"title": "Vram Total Gb",
"type": "number"
}
},
"required": [
"data_dir",
"outputs_dir",
"crash_log_path",
"idle_timeout_seconds"
],
"title": "SystemInfoResponse",
"type": "object"
},
"TranslateRequest": {
"properties": {
"auto_glossary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Glossary"
},
"condense": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Condense"
},
"dialect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dialect"
},
"glossary": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Glossary"
},
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Id"
},
"provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider"
},
"quality": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "fast",
"title": "Quality"
},
"reflect": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Reflect"
},
"segments": {
"items": {
"$ref": "#/components/schemas/TranslateSegment"
},
"title": "Segments",
"type": "array"
},
"source_lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Lang"
},
"target_lang": {
"title": "Target Lang",
"type": "string"
},
"translation_instructions": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Translation Instructions"
}
},
"required": [
"segments",
"target_lang"
],
"title": "TranslateRequest",
"type": "object"
},
"TranslateSegment": {
"properties": {
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction"
},
"end": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "End"
},
"id": {
"title": "Id",
"type": "string"
},
"slot_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Slot Seconds"
},
"start": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Start"
},
"target_lang": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Lang"
},
"text": {
"title": "Text",
"type": "string"
}
},
"required": [
"id",
"text"
],
"title": "TranslateSegment",
"type": "object"
},
"TranslationSelection": {
"properties": {
"engine_id": {
"title": "Engine Id",
"type": "string"
}
},
"required": [
"engine_id"
],
"title": "TranslationSelection",
"type": "object"
},
"ValidationError": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"WebSocketTicketRequest": {
"properties": {
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "WebSocketTicketRequest",
"type": "object"
},
"_ASROpenAICompatBody": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "'' clears it, None leaves unchanged",
"title": "Api Key"
},
"base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base Url"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model"
}
},
"title": "_ASROpenAICompatBody",
"type": "object"
},
"_AnalyticsBody": {
"properties": {
"enabled": {
"description": "User's explicit choice. Default is OFF.",
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "_AnalyticsBody",
"type": "object"
},
"_BindingBody": {
"properties": {
"client_id": {
"maxLength": 128,
"minLength": 1,
"title": "Client Id",
"type": "string"
},
"default_engine": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Engine"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label"
},
"profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Id"
}
},
"required": [
"client_id"
],
"title": "_BindingBody",
"type": "object"
},
"_CallBody": {
"properties": {
"brief": {
"maxLength": 4100,
"title": "Brief",
"type": "string"
},
"disclosure": {
"anyOf": [
{
"maxLength": 600,
"type": "string"
},
{
"type": "null"
}
],
"title": "Disclosure"
},
"engine": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
},
"language": {
"anyOf": [
{
"maxLength": 64,
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"max_minutes": {
"default": 10,
"minimum": 1.0,
"title": "Max Minutes",
"type": "integer"
},
"profile_id": {
"maxLength": 128,
"title": "Profile Id",
"type": "string"
},
"to": {
"maxLength": 32,
"title": "To",
"type": "string"
}
},
"required": [
"to",
"brief",
"profile_id"
],
"title": "_CallBody",
"type": "object"
},
"_ComputeDeviceBody": {
"properties": {
"value": {
"description": "auto | cuda | rocm | xpu | mps | cpu",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "_ComputeDeviceBody",
"type": "object"
},
"_ConfigBody": {
"properties": {
"account_sid": {
"anyOf": [
{
"maxLength": 64,
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Sid"
},
"auth_token": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"description": "'' clears, None keeps",
"title": "Auth Token"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled"
},
"engine": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
},
"greeting": {
"anyOf": [
{
"maxLength": 1100,
"type": "string"
},
{
"type": "null"
}
],
"title": "Greeting"
},
"language": {
"anyOf": [
{
"maxLength": 64,
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"public_base_url": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"title": "Public Base Url"
},
"voice_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Voice Id"
}
},
"title": "_ConfigBody",
"type": "object"
},
"_CudaDeviceBody": {
"properties": {
"value": {
"description": "auto or an NVIDIA GPU UUID",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "_CudaDeviceBody",
"type": "object"
},
"_HFMirrorBody": {
"properties": {
"mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "'auto' switches to automatic endpoint selection (clears any explicit endpoint); 'manual' (or omitted \u2014 back-compat with older clients) pins the given url as an explicit choice.",
"title": "Mode"
},
"url": {
"default": "",
"description": "HF_ENDPOINT URL; empty string clears it (official endpoint)",
"title": "Url",
"type": "string"
}
},
"title": "_HFMirrorBody",
"type": "object"
},
"_HFTokenBody": {
"properties": {
"token": {
"description": "HuggingFace access token",
"minLength": 1,
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "_HFTokenBody",
"type": "object"
},
"_HistoryRetentionBody": {
"properties": {
"cap": {
"description": "Max takes kept before the oldest UNstarred ones (rows + WAVs) are pruned; 0 = unlimited",
"maximum": 100000.0,
"minimum": 0.0,
"title": "Cap",
"type": "integer"
}
},
"required": [
"cap"
],
"title": "_HistoryRetentionBody",
"type": "object"
},
"_LLMActiveBody": {
"properties": {
"provider": {
"description": "provider id to activate",
"title": "Provider",
"type": "string"
}
},
"required": [
"provider"
],
"title": "_LLMActiveBody",
"type": "object"
},
"_LLMEndpointBody": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key"
},
"base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base Url"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model"
}
},
"title": "_LLMEndpointBody",
"type": "object"
},
"_LLMProviderBody": {
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Cloudflare account id",
"title": "Account Id"
},
"activate_if_unset": {
"default": true,
"title": "Activate If Unset",
"type": "boolean"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "API key; '' clears it, None leaves unchanged",
"title": "Api Key"
},
"base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base Url"
},
"make_active": {
"default": false,
"title": "Make Active",
"type": "boolean"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model"
}
},
"title": "_LLMProviderBody",
"type": "object"
},
"_LLMSkillBody": {
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "None leaves the toggle unchanged",
"title": "Enabled"
},
"provider_override": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "provider id to route this skill to; '' or null clears it (skill follows the active provider). Omit to leave unchanged.",
"title": "Provider Override"
}
},
"title": "_LLMSkillBody",
"type": "object"
},
"_LicenseAcceptBody": {
"properties": {
"accepted": {
"description": "True to accept the license terms",
"title": "Accepted",
"type": "boolean"
},
"engine_id": {
"maxLength": 64,
"minLength": 1,
"title": "Engine Id",
"type": "string"
}
},
"required": [
"engine_id",
"accepted"
],
"title": "_LicenseAcceptBody",
"type": "object"
},
"_ModelsDirBody": {
"properties": {
"authorization": {
"description": "One-shot native desktop authorization",
"title": "Authorization",
"type": "string"
}
},
"required": [
"authorization"
],
"title": "_ModelsDirBody",
"type": "object"
},
"_OffloadAfterGenerationBody": {
"properties": {
"enabled": {
"description": "True to move the TTS model to system RAM after each generation",
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "_OffloadAfterGenerationBody",
"type": "object"
},
"_PerformanceProfileBody": {
"properties": {
"family": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Engine family, or null to set the global tier",
"title": "Family"
},
"tier": {
"description": "fast | balanced | quality | max | auto",
"title": "Tier",
"type": "string"
}
},
"required": [
"tier"
],
"title": "_PerformanceProfileBody",
"type": "object"
},
"_PreviewBody": {
"properties": {
"engine": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
},
"language": {
"anyOf": [
{
"maxLength": 64,
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"text": {
"anyOf": [
{
"maxLength": 1100,
"type": "string"
},
{
"type": "null"
}
],
"title": "Text"
},
"voice_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"title": "Voice Id"
}
},
"title": "_PreviewBody",
"type": "object"
},
"_RefinementBody": {
"properties": {
"auto": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto"
},
"preserve_technical": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Preserve Technical"
},
"self_correction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Self Correction"
},
"smart_cleanup": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Smart Cleanup"
}
},
"title": "_RefinementBody",
"type": "object"
},
"_SayBody": {
"properties": {
"text": {
"maxLength": 600,
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "_SayBody",
"type": "object"
},
"_SettingsBody": {
"properties": {
"disclosure_template": {
"anyOf": [
{
"maxLength": 600,
"type": "string"
},
{
"type": "null"
}
],
"title": "Disclosure Template"
},
"from_number": {
"anyOf": [
{
"maxLength": 32,
"type": "string"
},
{
"type": "null"
}
],
"title": "From Number"
},
"inbound_brief": {
"anyOf": [
{
"maxLength": 4100,
"type": "string"
},
{
"type": "null"
}
],
"title": "Inbound Brief"
},
"inbound_mode": {
"anyOf": [
{
"maxLength": 16,
"type": "string"
},
{
"type": "null"
}
],
"title": "Inbound Mode"
},
"max_concurrent": {
"anyOf": [
{
"maximum": 2.0,
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Concurrent"
},
"record_calls": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Record Calls"
},
"user_name": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "User Name"
}
},
"title": "_SettingsBody",
"type": "object"
},
"_StarBody": {
"properties": {
"starred": {
"title": "Starred",
"type": "boolean"
}
},
"required": [
"starred"
],
"title": "_StarBody",
"type": "object"
},
"_TakeoverBody": {
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "_TakeoverBody",
"type": "object"
},
"_TorchCompileBody": {
"properties": {
"enabled": {
"description": "True to disable torch.compile (eager mode) for the engine",
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "_TorchCompileBody",
"type": "object"
},
"api__routers__sonitranslate__DubRequest": {
"properties": {
"max_speakers": {
"default": 1,
"title": "Max Speakers",
"type": "integer"
},
"output_authorization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Output Authorization"
},
"source_language": {
"default": "Automatic detection",
"title": "Source Language",
"type": "string"
},
"target_language": {
"default": "Spanish (es)",
"title": "Target Language",
"type": "string"
},
"tts_voice": {
"default": "es-ES-AlvaroNeural-Male",
"title": "Tts Voice",
"type": "string"
},
"video_authorization": {
"title": "Video Authorization",
"type": "string"
}
},
"required": [
"video_authorization"
],
"title": "DubRequest",
"type": "object"
},
"schemas__requests__DubRequest": {
"properties": {
"fit_options": {
"anyOf": [
{
"$ref": "#/components/schemas/FitOptions"
},
{
"type": "null"
}
]
},
"guidance_scale": {
"default": 2.0,
"title": "Guidance Scale",
"type": "number"
},
"instruct": {
"default": "",
"title": "Instruct",
"type": "string"
},
"language": {
"default": "Auto",
"title": "Language",
"type": "string"
},
"language_code": {
"default": "und",
"title": "Language Code",
"type": "string"
},
"num_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Step"
},
"overflow_budget_s": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": 0.0,
"title": "Overflow Budget S"
},
"preview": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Preview"
},
"regen_only": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Regen Only"
},
"segment_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Segment Ids"
},
"segments": {
"items": {
"$ref": "#/components/schemas/DubSegment"
},
"minItems": 1,
"title": "Segments",
"type": "array"
},
"slot_fit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "time_stretch",
"title": "Slot Fit"
},
"speed": {
"default": 1.0,
"title": "Speed",
"type": "number"
},
"timing_strategy": {
"anyOf": [
{
"enum": [
"concise",
"stretch_video",
"strict_slot",
"smart_fit"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "concise",
"title": "Timing Strategy"
},
"voice_match": {
"anyOf": [
{
"enum": [
"per_line",
"consistent"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "per_line",
"title": "Voice Match"
}
},
"required": [
"segments"
],
"title": "DubRequest",
"type": "object"
}
}
},
"info": {
"title": "VoiceStudio API",
"version": "0.0.0"
},
"openapi": "3.1.0",
"paths": {
"/.well-known/voicestudio-speech": {
"get": {
"description": "Advertise batch, streaming, and agent-facing speech transports.",
"operationId": "get_speech_capabilities__well_known_voicestudio_speech_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpeechCapabilities"
}
}
},
"description": "Successful Response"
}
},
"summary": "Get Speech Capabilities",
"tags": [
"Speech Platform"
]
}
},
"/api/auth/session": {
"delete": {
"operationId": "delete_session_api_auth_session_delete",
"responses": {
"204": {
"description": "Successful Response"
}
},
"summary": "Delete Session",
"tags": [
"auth"
]
},
"post": {
"operationId": "create_session_api_auth_session_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Session",
"tags": [
"auth"
]
}
},
"/api/auth/ws-ticket": {
"post": {
"operationId": "create_ws_ticket_api_auth_ws_ticket_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebSocketTicketRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Ws Ticket",
"tags": [
"auth"
]
}
},
"/api/cloud-sync/choices": {
"put": {
"operationId": "set_choices_api_cloud_sync_choices_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChoicesBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Set Choices Api Cloud Sync Choices Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Choices",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/confirm-deletes": {
"post": {
"operationId": "confirm_deletes_api_cloud_sync_confirm_deletes_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Confirm Deletes Api Cloud Sync Confirm Deletes Post",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Confirm Deletes",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/devices": {
"get": {
"operationId": "devices_api_cloud_sync_devices_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Devices Api Cloud Sync Devices Get",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Devices",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/devices/{device_id}/revoke": {
"post": {
"operationId": "revoke_api_cloud_sync_devices__device_id__revoke_post",
"parameters": [
{
"in": "path",
"name": "device_id",
"required": true,
"schema": {
"pattern": "^[A-Za-z0-9]{16}$",
"title": "Device Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Revoke Api Cloud Sync Devices Device Id Revoke Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/local": {
"get": {
"operationId": "pulled_local_api_cloud_sync_local_get",
"parameters": [
{
"in": "query",
"name": "since",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"title": "Since",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Pulled Local Api Cloud Sync Local Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Pulled Local",
"tags": [
"cloud-sync"
]
},
"put": {
"operationId": "put_local_api_cloud_sync_local_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocalValue"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put Local Api Cloud Sync Local Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Local",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/local/keys": {
"get": {
"operationId": "local_keys_api_cloud_sync_local_keys_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Local Keys Api Cloud Sync Local Keys Get",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Local Keys",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/off": {
"post": {
"operationId": "turn_off_api_cloud_sync_off_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Turn Off Api Cloud Sync Off Post",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Turn Off",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/on": {
"post": {
"operationId": "turn_on_api_cloud_sync_on_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChoicesBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Turn On Api Cloud Sync On Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Turn On",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/run": {
"post": {
"description": "Window focus or \"Sync now\": also starts sync if it could not start earlier.",
"operationId": "run_now_api_cloud_sync_run_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Run Now Api Cloud Sync Run Post",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Run Now",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/start": {
"post": {
"description": "Main: sync was switched on (or the app started signed in).",
"operationId": "start_api_cloud_sync_start_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Start Api Cloud Sync Start Post",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Start",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/status": {
"get": {
"operationId": "status_api_cloud_sync_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Status Api Cloud Sync Status Get",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Status",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/stop": {
"post": {
"description": "Main: sync or account features were switched off. Stops everything now.",
"operationId": "stop_api_cloud_sync_stop_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Stop Api Cloud Sync Stop Post",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Stop",
"tags": [
"cloud-sync"
]
}
},
"/api/cloud-sync/use-choices-of/{device_id}": {
"post": {
"operationId": "use_choices_of_api_cloud_sync_use_choices_of__device_id__post",
"parameters": [
{
"in": "path",
"name": "device_id",
"required": true,
"schema": {
"pattern": "^[A-Za-z0-9]{16}$",
"title": "Device Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Use Choices Of Api Cloud Sync Use Choices Of Device Id Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Use Choices Of",
"tags": [
"cloud-sync"
]
}
},
"/api/integrations/twilio/config": {
"put": {
"operationId": "put_config_api_integrations_twilio_config_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_ConfigBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Config",
"tags": [
"integrations"
]
}
},
"/api/integrations/twilio/state": {
"get": {
"operationId": "get_state_api_integrations_twilio_state_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get State",
"tags": [
"integrations"
]
}
},
"/api/integrations/twilio/test": {
"post": {
"description": "Render the greeting exactly as a caller would hear it \u2014 resampled to\n8 kHz, \u03bc-law encoded, decoded \u2014 and return it as a WAV. Works while the\nintegration is disabled; nothing leaves the machine. Also warms the cache,\nso a following call with the same settings answers instantly.",
"operationId": "test_locally_api_integrations_twilio_test_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_PreviewBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Test Locally",
"tags": [
"integrations"
]
}
},
"/api/mcp/bindings": {
"get": {
"description": "All per-agent voice bindings, most-recently-seen first.",
"operationId": "list_bindings_api_mcp_bindings_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Bindings",
"tags": [
"mcp"
]
},
"put": {
"description": "Create or update the binding for an MCP client id.",
"operationId": "upsert_binding_api_mcp_bindings_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_BindingBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Upsert Binding",
"tags": [
"mcp"
]
}
},
"/api/mcp/bindings/{client_id}": {
"delete": {
"operationId": "delete_binding_api_mcp_bindings__client_id__delete",
"parameters": [
{
"in": "path",
"name": "client_id",
"required": true,
"schema": {
"title": "Client Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Binding",
"tags": [
"mcp"
]
}
},
"/api/settings/analytics": {
"get": {
"operationId": "get_analytics_api_settings_analytics_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Analytics",
"tags": [
"settings"
]
},
"put": {
"operationId": "set_analytics_api_settings_analytics_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_AnalyticsBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Analytics",
"tags": [
"settings"
]
}
},
"/api/settings/asr-openai-compat": {
"get": {
"operationId": "get_asr_openai_compat_api_settings_asr_openai_compat_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Asr Openai Compat",
"tags": [
"settings"
]
},
"put": {
"operationId": "set_asr_openai_compat_api_settings_asr_openai_compat_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_ASROpenAICompatBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Asr Openai Compat",
"tags": [
"settings"
]
}
},
"/api/settings/asr-openai-compat/test": {
"post": {
"description": "Cheap connectivity probe for the \"Test connection\" button.\n\nGET {base_url}/models against the PERSISTED config \u2014 the panel saves\nfirst, then tests, same stale-config contract as\n/llm-providers/{id}/test. No audio leaves the machine, nothing is\ntranscribed. Loopback-only via the router-level guard. Always 200 with a\nstructured verdict ({ok, status, latency_ms, ...} \u2014 see\nservices.asr_backend.probe_openai_compat_server) so the UI renders\nsuccess/latency or the exact failure without a raw 500. The key is never\nlogged or echoed back.",
"operationId": "test_asr_openai_compat_api_settings_asr_openai_compat_test_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Test Asr Openai Compat",
"tags": [
"settings"
]
}
},
"/api/settings/changelog": {
"get": {
"description": "Structured release notes from the shipped CHANGELOG.md (newest first).\n\nBullets are raw markdown-lite (bold leads, `code`, (#NNN) refs) \u2014 the\nfrontend renders them safely without HTML. `available: false` when this\ninstall has no changelog (never an error: the viewer just hides).",
"operationId": "get_changelog_api_settings_changelog_get",
"parameters": [
{
"in": "query",
"name": "limit_versions",
"required": false,
"schema": {
"default": 5,
"maximum": 50,
"minimum": 1,
"title": "Limit Versions",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Changelog",
"tags": [
"settings"
]
}
},
"/api/settings/compute-device": {
"get": {
"description": "Current compute-device override state (Settings \u2192 Performance).",
"operationId": "get_compute_device_api_settings_compute_device_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Compute Device",
"tags": [
"settings"
]
},
"put": {
"description": "Persist the compute-device pick. Applied by the capability probe at\nthe next backend start (host caps are immutable per process \u2014 same\nrestart contract as the rest of the Performance tab). ``OMNIVOICE_DEVICE``\nalways wins over this pick; the UI shows the pin instead of pretending.",
"operationId": "set_compute_device_api_settings_compute_device_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_ComputeDeviceBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Compute Device",
"tags": [
"settings"
]
}
},
"/api/settings/cuda-device": {
"get": {
"description": "Physical CUDA adapter selected for the next backend launch.",
"operationId": "get_cuda_device_api_settings_cuda_device_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Cuda Device",
"tags": [
"settings"
]
},
"put": {
"description": "Persist CUDA_VISIBLE_DEVICES before torch is imported on next launch.",
"operationId": "set_cuda_device_api_settings_cuda_device_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_CudaDeviceBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Cuda Device",
"tags": [
"settings"
]
}
},
"/api/settings/db-backup": {
"get": {
"description": "Newest pre-migration database backup (or none yet). Feeds the\n\"your data is backed up before every update\" line in Settings \u2192 Updates.",
"operationId": "get_db_backup_state_api_settings_db_backup_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Db Backup State",
"tags": [
"settings"
]
}
},
"/api/settings/dictation-refinement": {
"get": {
"description": "Current refinement config + whether an LLM backend is configured.",
"operationId": "get_dictation_refinement_api_settings_dictation_refinement_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Dictation Refinement",
"tags": [
"settings"
]
},
"put": {
"operationId": "set_dictation_refinement_api_settings_dictation_refinement_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_RefinementBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Dictation Refinement",
"tags": [
"settings"
]
}
},
"/api/settings/gpu-report": {
"get": {
"description": "Which engines will use the GPU on this host, and why not otherwise.\n\nCodes + params only (the renderer owns the prose, via i18n): the physical\nGPUs, the installed PyTorch build, a host state such as ``amd_cuda_build``,\nthe honest options for that state, and a verdict per TTS/ASR engine.",
"operationId": "get_gpu_report_api_settings_gpu_report_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Gpu Report",
"tags": [
"settings"
]
}
},
"/api/settings/hf-mirror": {
"get": {
"operationId": "get_hf_mirror_api_settings_hf_mirror_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Hf Mirror",
"tags": [
"settings"
]
},
"put": {
"operationId": "set_hf_mirror_api_settings_hf_mirror_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_HFMirrorBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Hf Mirror",
"tags": [
"settings"
]
}
},
"/api/settings/hf-mirror/test": {
"post": {
"description": "Re-run the endpoint race now (the Auto panel's \"Test again\").\n\nForces fresh probes and re-caches the decision. In manual mode this is a\nno-op (an explicit endpoint is never auto-switched) \u2014 the response simply\nreflects the current state.",
"operationId": "test_hf_mirror_api_settings_hf_mirror_test_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Test Hf Mirror",
"tags": [
"settings"
]
}
},
"/api/settings/hf-token": {
"delete": {
"description": "Clear the App token and optionally recognized local Hub token files.",
"operationId": "clear_hf_token_api_settings_hf_token_delete",
"parameters": [
{
"in": "query",
"name": "also_clear_hf_cli",
"required": false,
"schema": {
"default": false,
"title": "Also Clear Hf Cli",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Hf Token",
"tags": [
"settings"
]
},
"post": {
"description": "Persist a new HF token to the encrypted settings store + the HF\ncanonical file (via huggingface_hub.login). Returns the updated\ncascade state.",
"operationId": "save_hf_token_api_settings_hf_token_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_HFTokenBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Save Hf Token",
"tags": [
"settings"
]
}
},
"/api/settings/hf-token/state": {
"get": {
"description": "3-source HF token cascade state for the Settings UI.\n\n``fresh=1`` drops the resolver's whoami validation cache first so the\nresponse re-runs whoami for every source \u2014 this is what the panel's\n\"Test now\" button sends. Plain GETs only inspect local token presence.",
"operationId": "get_hf_token_state_api_settings_hf_token_state_get",
"parameters": [
{
"in": "query",
"name": "fresh",
"required": false,
"schema": {
"default": false,
"title": "Fresh",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Hf Token State",
"tags": [
"settings"
]
}
},
"/api/settings/history-retention": {
"get": {
"description": "Current generation-history retention cap (Settings \u2192 Storage).",
"operationId": "get_history_retention_api_settings_history_retention_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get History Retention",
"tags": [
"settings"
]
},
"put": {
"description": "Persist the retention cap. Enforced after every generation: the oldest\nunstarred takes over the cap are pruned (rows + their audio files);\nstarred takes are never pruned. 0 disables pruning entirely.",
"operationId": "set_history_retention_api_settings_history_retention_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_HistoryRetentionBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set History Retention",
"tags": [
"settings"
]
}
},
"/api/settings/license": {
"post": {
"description": "Persist a per-engine license-acceptance boolean.\n\nReturns ``{\"ok\": True, \"engine_id\": ..., \"accepted\": ...}`` so the\ncaller can update its UI without a second round-trip. Validation:\n``engine_id`` must be in the in-tree allow-list \u2011\u2011 refuses arbitrary\nkeys so the settings table can't be polluted via this route.",
"operationId": "post_license_acceptance_api_settings_license_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_LicenseAcceptBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Post License Acceptance Api Settings License Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Post License Acceptance",
"tags": [
"settings"
]
}
},
"/api/settings/license/{engine_id}": {
"get": {
"description": "Return ``{\"engine_id\": ..., \"accepted\": bool}``.\n\nSame allow-list as the POST handler so an unknown engine id is a\n400 rather than a silent ``accepted=false`` for a non-existent\nengine.",
"operationId": "get_license_acceptance_api_settings_license__engine_id__get",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get License Acceptance Api Settings License Engine Id Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get License Acceptance",
"tags": [
"settings"
]
}
},
"/api/settings/llm-endpoint": {
"get": {
"description": "Current OpenAI-compatible LLM endpoint config + live availability.",
"operationId": "get_llm_endpoint_api_settings_llm_endpoint_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Llm Endpoint",
"tags": [
"settings"
]
},
"put": {
"description": "Persist base URL / model / API key for the OpenAI-compatible endpoint.\n\nReuses the env-var persistence path (prefs.json, restored at startup):\nbase_url -> TRANSLATE_BASE_URL, model -> TRANSLATE_MODEL,\napi_key -> encrypted TRANSLATE_API_KEY storage. A None field is left unchanged; an empty\nstring clears it. Ollama ignores the key; vLLM / LM Studio require it.",
"operationId": "set_llm_endpoint_api_settings_llm_endpoint_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_LLMEndpointBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Llm Endpoint",
"tags": [
"settings"
]
}
},
"/api/settings/llm-providers": {
"get": {
"description": "All providers with resolved base_url/model + whether a key is configured.\n\nNever returns key material \u2014 only `has_key`/`key_from_env` booleans.",
"operationId": "list_llm_providers_api_settings_llm_providers_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Llm Providers",
"tags": [
"settings"
]
}
},
"/api/settings/llm-providers/active": {
"post": {
"operationId": "set_active_llm_provider_api_settings_llm_providers_active_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_LLMActiveBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Active Llm Provider",
"tags": [
"settings"
]
}
},
"/api/settings/llm-providers/{provider_id}": {
"put": {
"description": "Save a provider's key (encrypted) + optional base_url/model/account.\n\nA None field is left unchanged; an empty api_key clears the stored key.",
"operationId": "save_llm_provider_api_settings_llm_providers__provider_id__put",
"parameters": [
{
"in": "path",
"name": "provider_id",
"required": true,
"schema": {
"title": "Provider Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_LLMProviderBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Save Llm Provider",
"tags": [
"settings"
]
}
},
"/api/settings/llm-providers/{provider_id}/connect": {
"post": {
"description": "Enable a provider only after it returns a usable completion.",
"operationId": "connect_llm_provider_api_settings_llm_providers__provider_id__connect_post",
"parameters": [
{
"in": "path",
"name": "provider_id",
"required": true,
"schema": {
"title": "Provider Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Llm Provider",
"tags": [
"settings"
]
}
},
"/api/settings/llm-providers/{provider_id}/models": {
"get": {
"description": "List model ids the provider's key can access (OpenAI-compat /models).\n\nPowers the model-picker datalist in Settings \u2192 LLM Providers so users\ndon't have to guess model names. Read-only; failures return the same\nclassified shape as /test; capped so a huge catalog can't bloat the UI.",
"operationId": "list_llm_provider_models_api_settings_llm_providers__provider_id__models_get",
"parameters": [
{
"in": "path",
"name": "provider_id",
"required": true,
"schema": {
"title": "Provider Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Llm Provider Models",
"tags": [
"settings"
]
}
},
"/api/settings/llm-providers/{provider_id}/test": {
"post": {
"description": "One cheap round-trip against a provider to prove the key/URL work.\n\nTemporarily activates the provider for the probe by resolving its config\ndirectly (does not change the persisted active selection). Returns\nlatency_ms plus, on failure, a classified ``kind`` (config / auth /\nnot_found / rate_limit / network / error) so the UI shows an actionable,\nlocalizable message instead of a raw exception string.",
"operationId": "test_llm_provider_api_settings_llm_providers__provider_id__test_post",
"parameters": [
{
"in": "path",
"name": "provider_id",
"required": true,
"schema": {
"title": "Provider Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Test Llm Provider",
"tags": [
"settings"
]
}
},
"/api/settings/llm-skills": {
"get": {
"description": "Every LLM skill with its toggle, routing, and resolved ready status.",
"operationId": "list_llm_skills_api_settings_llm_skills_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Llm Skills",
"tags": [
"settings"
]
}
},
"/api/settings/llm-skills/{skill_id}": {
"put": {
"description": "Toggle a skill and/or set its provider routing.\n\nField semantics match the providers PUT: an omitted field is left\nunchanged; ``provider_override: \"\"``/``null`` clears the override.\n404 for an unknown skill or an unknown provider id.",
"operationId": "set_llm_skill_api_settings_llm_skills__skill_id__put",
"parameters": [
{
"in": "path",
"name": "skill_id",
"required": true,
"schema": {
"title": "Skill Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_LLMSkillBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Llm Skill",
"tags": [
"settings"
]
}
},
"/api/settings/perf/offload-after-generation": {
"get": {
"description": "Whether the in-process TTS model moves to system RAM after generation.",
"operationId": "get_offload_after_generation_api_settings_perf_offload_after_generation_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Offload After Generation",
"tags": [
"settings"
]
},
"put": {
"description": "Persist the toggle. Applies from the next generation, no restart.",
"operationId": "set_offload_after_generation_api_settings_perf_offload_after_generation_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_OffloadAfterGenerationBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Offload After Generation",
"tags": [
"settings"
]
}
},
"/api/settings/perf/torch-compile-disabled": {
"get": {
"description": "Return the current torch.compile-disabled toggle + the runtime platform.\n\n`platform` is still reported (clients may show it), but since #2135 the\ntoggle is live on every host: it used to be rendered disabled off Windows\non the assumption that only #65's Windows OOM needed it, which left the\nLinux/CUDA reporter of #2135 with no way to switch off the compile that\nwas killing their backend.",
"operationId": "get_torch_compile_disabled_api_settings_perf_torch_compile_disabled_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Torch Compile Disabled",
"tags": [
"settings"
]
},
"put": {
"description": "Persist the toggle. Honoured by `services.engine_env.build_engine_env()`\n(subprocess engines) and `services.engine_env.should_torch_compile()`\n(in-process), on every platform since #2135.",
"operationId": "set_torch_compile_disabled_api_settings_perf_torch_compile_disabled_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_TorchCompileBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Torch Compile Disabled",
"tags": [
"settings"
]
}
},
"/api/settings/performance-profile": {
"get": {
"description": "Return the global speed/quality preference and per-engine overrides.",
"operationId": "get_performance_profile_api_settings_performance_profile_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Performance Profile",
"tags": [
"settings"
]
},
"put": {
"description": "Persist a performance preference and apply installed compatible picks.",
"operationId": "set_performance_profile_api_settings_performance_profile_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_PerformanceProfileBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Performance Profile",
"tags": [
"settings"
]
}
},
"/api/settings/storage": {
"get": {
"description": "Disk + per-category storage usage for the Settings \u2192 Storage panel.\n\n`refresh=1` bypasses the 5-minute cache and rescans. `min_free_gb`\nreuses the setup wizard's constant so both surfaces warn at the same\nthreshold.",
"operationId": "get_storage_report_api_settings_storage_get",
"parameters": [
{
"in": "query",
"name": "refresh",
"required": false,
"schema": {
"default": false,
"title": "Refresh",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Storage Report",
"tags": [
"settings"
]
}
},
"/api/settings/storage/models-dir": {
"get": {
"description": "Current models directory: the persisted choice (from the durable env\nfile \u2014 the same value main.py reads at startup), what's effective in this\nprocess, and the platform default.",
"operationId": "get_models_dir_api_settings_storage_models_dir_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Models Dir",
"tags": [
"settings"
]
},
"put": {
"description": "Set (or clear, with an empty path) the models download directory.\n\nValidates the directory is writable, then writes OMNIVOICE_CACHE_DIR to the\ndurable per-user env file so main.py applies it on the next launch. The env\nfile is the only persisted store, so GET can never diverge from what was\nsaved. Returns restart_required=True.",
"operationId": "set_models_dir_api_settings_storage_models_dir_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_ModelsDirBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Models Dir",
"tags": [
"settings"
]
}
},
"/api/settings/storage/temp/clear": {
"post": {
"description": "Delete VoiceStudio-owned temp files (Settings \u2192 Storage \u2192 Temporary files).\n\nRemoves only the ``omnivoice*`` entries in the OS temp dir \u2014 the exact\npopulation the storage report's \"temp\" category counts \u2014 and invalidates\nthe cached report so the next scan reflects the reclaimed space. Partial\nfailures (files held open by a running job) are returned per entry.",
"operationId": "clear_temp_files_api_settings_storage_temp_clear_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Clear Temp Files",
"tags": [
"settings"
]
}
},
"/archetypes": {
"get": {
"description": "Filtered, paginated view over the archetype catalog.\n\n``q`` is a free-text substring match over the archetype name/instruct so a\nvoice picker can search the *entire* several-hundred-voice catalog by typing\n(the facet filters alone can't reach a specific voice by name). Content-free\nand local \u2014 it just narrows the in-memory catalog.",
"operationId": "list_archetypes_endpoint_archetypes_get",
"parameters": [
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Q"
}
},
{
"in": "query",
"name": "use_case",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Use Case"
}
},
{
"in": "query",
"name": "gender",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gender"
}
},
{
"in": "query",
"name": "age",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Age"
}
},
{
"in": "query",
"name": "pitch",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pitch"
}
},
{
"in": "query",
"name": "accent",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accent"
}
},
{
"in": "query",
"name": "whisper",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Whisper"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lang"
}
},
{
"in": "query",
"name": "featured",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Featured"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 60,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"title": "Offset",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Archetypes Endpoint"
}
},
"/archetypes/categories": {
"get": {
"description": "The seven use-case categories the gallery is organized by.",
"operationId": "list_categories_archetypes_categories_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Categories"
}
},
"/archetypes/previews": {
"put": {
"description": "Turn pre-rendered previews on or off.\n\nTurning it ON is the user's explicit yes to an outbound call, and is the\nonly thing that ever starts one \u2014 there is no on-install background fetch.\nThe featured set is pulled right here so the yes has a visible effect;\nfailures are silent by design (``fetch_featured`` swallows them) and leave\npreviews rendering locally.",
"operationId": "set_preview_gallery_archetypes_previews_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_set_preview_gallery_archetypes_previews_put"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Preview Gallery"
}
},
"/archetypes/previews/check": {
"post": {
"description": "Manual \"check now\" \u2014 bypasses the 24 h throttle, never the signature.",
"operationId": "check_preview_gallery_archetypes_previews_check_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Check Preview Gallery"
}
},
"/archetypes/previews/status": {
"get": {
"description": "Consent state, coverage and freshness for the Settings line.",
"operationId": "preview_gallery_status_archetypes_previews_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Preview Gallery Status"
}
},
"/archetypes/{archetype_id}": {
"get": {
"operationId": "get_archetype_endpoint_archetypes__archetype_id__get",
"parameters": [
{
"in": "path",
"name": "archetype_id",
"required": true,
"schema": {
"title": "Archetype Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Archetype Endpoint"
}
},
"/archetypes/{archetype_id}/preview": {
"get": {
"description": "Serve a short preview clip \u2014 from the gallery, the cache, or the engine.",
"operationId": "preview_archetype_archetypes__archetype_id__preview_get",
"parameters": [
{
"in": "path",
"name": "archetype_id",
"required": true,
"schema": {
"title": "Archetype Id",
"type": "string"
}
},
{
"description": "Bypass gallery audio after a client decode failure",
"in": "query",
"name": "local",
"required": false,
"schema": {
"default": false,
"description": "Bypass gallery audio after a client decode failure",
"title": "Local",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Archetype"
}
},
"/archetypes/{archetype_id}/preview/state": {
"get": {
"description": "Where the next ``/preview`` for this archetype would come from.\n\nTouches neither the model nor the network, so a picker can label a voice\n(\"may take a moment\", \"download a model first\") *before* it commits to a\nrequest that may take 40 seconds or fail.",
"operationId": "preview_archetype_state_archetypes__archetype_id__preview_state_get",
"parameters": [
{
"in": "path",
"name": "archetype_id",
"required": true,
"schema": {
"title": "Archetype Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Archetype State"
}
},
"/archetypes/{archetype_id}/use": {
"post": {
"description": "Save an archetype recipe as a reusable design profile without rendering.",
"operationId": "use_archetype_archetypes__archetype_id__use_post",
"parameters": [
{
"in": "path",
"name": "archetype_id",
"required": true,
"schema": {
"title": "Archetype Id",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Use Archetype"
}
},
"/audio/{audio_id}.ogg": {
"get": {
"description": "Serve the same render as /audio/<id>.wav, encoded as Ogg/Opus.",
"operationId": "generated_ogg_opus_audio__audio_id__ogg_get",
"parameters": [
{
"in": "path",
"name": "audio_id",
"required": true,
"schema": {
"title": "Audio Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generated Ogg Opus"
}
},
"/audio/{audio_id}.opus": {
"get": {
"description": "Serve the same render as /audio/<id>.wav, encoded as Ogg/Opus.",
"operationId": "generated_ogg_opus_audio__audio_id__opus_get",
"parameters": [
{
"in": "path",
"name": "audio_id",
"required": true,
"schema": {
"title": "Audio Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generated Ogg Opus"
}
},
"/audio/{audio_id}/quality": {
"get": {
"description": "Analyze a generated WAV locally, off the async event loop.",
"operationId": "generated_audio_quality_audio__audio_id__quality_get",
"parameters": [
{
"in": "path",
"name": "audio_id",
"required": true,
"schema": {
"title": "Audio Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generated Audio Quality"
}
},
"/audiobook": {
"post": {
"description": "Synthesize a chapterized audiobook from a script, streaming SSE progress.",
"operationId": "audiobook_synthesize_audiobook_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudiobookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Audiobook Synthesize"
}
},
"/audiobook/cover": {
"post": {
"description": "Upload a cover image; returns a server-side ``path`` to pass back as\n``cover_path`` in the synth request. Validated here (jpg/png + size cap) and\nagain at render time.",
"operationId": "audiobook_cover_audiobook_cover_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_audiobook_cover_audiobook_cover_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Audiobook Cover Audiobook Cover Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Audiobook Cover"
}
},
"/audiobook/import": {
"post": {
"description": "Import a ``.txt``/``.md``/``.epub``/``.pdf`` into a chapter-delimited script.\n\nEPUB is parsed in spine order (stdlib only, local); PDF text is extracted\nwith pypdf (pure-Python) then chapterized; plain text gets ``# `` headings\ninserted ahead of obvious chapter-title lines. Returns the script text (for\nthe editor) + the resulting chapter count.",
"operationId": "audiobook_import_audiobook_import_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_audiobook_import_audiobook_import_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Audiobook Import Audiobook Import Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Audiobook Import"
}
},
"/audiobook/jobs": {
"get": {
"description": "List interrupted longform renders that can be resumed \u2014 a work dir that\nstill holds a resume manifest (a job left mid-render by a crash/quit). The\nids come from scanning the filesystem, so the UI can offer one-click resume.",
"operationId": "list_resumable_jobs_audiobook_jobs_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Resumable Jobs Audiobook Jobs Get",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "List Resumable Jobs"
}
},
"/audiobook/plan": {
"post": {
"description": "Parse a script into a chapter/span plan (pure preview, no synthesis).",
"operationId": "audiobook_plan_audiobook_plan_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudiobookPlanRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Audiobook Plan Audiobook Plan Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Audiobook Plan"
}
},
"/audiobook/preview": {
"post": {
"description": "Render a single chapter so the user can audition it before the full run.\n\nReuses the same content-addressed cache as the job, so a preview warms the\ncache (the later full render reuses it) and a re-preview is instant.",
"operationId": "audiobook_preview_audiobook_preview_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudiobookPreviewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Audiobook Preview Audiobook Preview Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Audiobook Preview"
}
},
"/audiobook/resume/{job_id}": {
"post": {
"description": "Resume an interrupted longform render from its persisted manifest. The\nalready-rendered chapters are content-addressed in the shared cache, so they\nreturn instantly \u2014 only the unrendered chapters synthesize again. Streams the\nsame SSE event shape as the original render, under a fresh job_id.",
"operationId": "resume_longform_audiobook_resume__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Resume Longform"
}
},
"/batch/download/{job_id}/{lang}": {
"get": {
"description": "Download a completed batch job's output video for a given language.",
"operationId": "download_batch_output_batch_download__job_id___lang__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "path",
"name": "lang",
"required": true,
"schema": {
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Download Batch Output"
}
},
"/batch/enqueue": {
"post": {
"description": "Enqueue a video for batch dubbing.\n\nThe video is saved to disk and a job is added to the queue.\nReturns the job ID for status polling.",
"operationId": "enqueue_batch_job_batch_enqueue_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_enqueue_batch_job_batch_enqueue_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Enqueue Batch Job"
}
},
"/batch/jobs": {
"get": {
"description": "List batch jobs, optionally filtered by status.",
"operationId": "list_batch_jobs_batch_jobs_get",
"parameters": [
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Batch Jobs"
}
},
"/batch/jobs/{job_id}": {
"delete": {
"description": "Delete a batch job record and every app-owned input/output file.",
"operationId": "delete_batch_job_batch_jobs__job_id__delete",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Batch Job"
},
"get": {
"description": "Get the status of a specific batch job.",
"operationId": "get_batch_job_batch_jobs__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Batch Job"
}
},
"/batch/jobs/{job_id}/cancel": {
"post": {
"description": "Cancel a queued or running batch job.",
"operationId": "cancel_batch_job_batch_jobs__job_id__cancel_post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Batch Job"
}
},
"/batch/jobs/{job_id}/retry": {
"post": {
"description": "Retry a terminal job using its original app-owned upload and settings.",
"operationId": "retry_batch_job_batch_jobs__job_id__retry_post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Retry Batch Job"
}
},
"/calls": {
"get": {
"operationId": "list_calls_calls_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Calls",
"tags": [
"calls"
]
},
"post": {
"operationId": "place_call_calls_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_CallBody"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Place Call",
"tags": [
"calls"
]
}
},
"/calls/readiness": {
"get": {
"description": "The guided-setup checklist: ``[{id, ok, detail}]`` for credentials,\ntunnel, number, llm, asr and voice, in that order.",
"operationId": "get_readiness_calls_readiness_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Readiness",
"tags": [
"calls"
]
}
},
"/calls/settings": {
"get": {
"operationId": "get_settings_calls_settings_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Settings",
"tags": [
"calls"
]
},
"put": {
"operationId": "put_settings_calls_settings_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_SettingsBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Settings",
"tags": [
"calls"
]
}
},
"/calls/{call_id}": {
"delete": {
"operationId": "delete_call_calls__call_id__delete",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Call",
"tags": [
"calls"
]
},
"get": {
"operationId": "get_call_calls__call_id__get",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Call",
"tags": [
"calls"
]
}
},
"/calls/{call_id}/events": {
"get": {
"description": "Server-sent events until the call ends: status, transcript,\nagent_state, outcome, then ended (after which the stream closes).",
"operationId": "call_events_calls__call_id__events_get",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Call Events",
"tags": [
"calls"
]
}
},
"/calls/{call_id}/hangup": {
"post": {
"operationId": "hangup_calls__call_id__hangup_post",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Hangup",
"tags": [
"calls"
]
}
},
"/calls/{call_id}/recording": {
"get": {
"operationId": "get_recording_calls__call_id__recording_get",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Recording",
"tags": [
"calls"
]
}
},
"/calls/{call_id}/say": {
"post": {
"operationId": "say_calls__call_id__say_post",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_SayBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Say",
"tags": [
"calls"
]
}
},
"/calls/{call_id}/takeover": {
"post": {
"operationId": "takeover_calls__call_id__takeover_post",
"parameters": [
{
"in": "path",
"name": "call_id",
"required": true,
"schema": {
"title": "Call Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_TakeoverBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Takeover",
"tags": [
"calls"
]
}
},
"/clean-audio": {
"post": {
"description": "Accept a raw mic recording, run demucs vocal isolation, return clean WAV.",
"operationId": "clean_audio_clean_audio_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_clean_audio_clean_audio_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clean Audio"
}
},
"/community/items": {
"get": {
"operationId": "community_items_community_items_get",
"parameters": [
{
"in": "query",
"name": "use_case",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Use Case"
}
},
{
"in": "query",
"name": "gender",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gender"
}
},
{
"in": "query",
"name": "type",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lang"
}
},
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Q"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 60,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "query",
"name": "refresh",
"required": false,
"schema": {
"default": false,
"title": "Refresh",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Community Items"
}
},
"/community/items/{item_id}/preview": {
"get": {
"description": "Serve every community preview through the authenticated same-origin API.",
"operationId": "community_preview_community_items__item_id__preview_get",
"parameters": [
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"title": "Item Id",
"type": "string"
}
},
{
"description": "Bypass canonical gallery audio after decode failure",
"in": "query",
"name": "local",
"required": false,
"schema": {
"default": false,
"description": "Bypass canonical gallery audio after decode failure",
"title": "Local",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Community Preview"
}
},
"/community/items/{item_id}/use": {
"post": {
"description": "Materialize a community item into a reusable voice profile.\n\nPreset \u2192 save its recipe without synthesis. Voice \u2192 download the\n(host-allow-listed, SHA-256-verified) reference clip.",
"operationId": "community_use_community_items__item_id__use_post",
"parameters": [
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"title": "Item Id",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Community Use"
}
},
"/community/manifest": {
"get": {
"operationId": "community_manifest_community_manifest_get",
"parameters": [
{
"in": "query",
"name": "refresh",
"required": false,
"schema": {
"default": false,
"title": "Refresh",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Community Manifest"
}
},
"/community/sources": {
"get": {
"description": "The content repos the gallery loads from (default: omnivoice-gallery).",
"operationId": "community_sources_community_sources_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Community Sources"
}
},
"/community/submit-url": {
"get": {
"description": "Build the prefilled GitHub submission URL (server-free, local-first).",
"operationId": "community_submit_url_community_submit_url_get",
"parameters": [
{
"in": "query",
"name": "type",
"required": false,
"schema": {
"default": "preset",
"title": "Type",
"type": "string"
}
},
{
"in": "query",
"name": "source",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Community Submit Url"
}
},
"/convert": {
"post": {
"description": "Convert a spoken clip into an existing voice profile's voice.\n\nMultipart form: ``audio`` (the source clip), ``profile_id`` (an existing\nvoice profile), optional ``match_duration`` (default on \u2014 atempo the take\ntoward the source clip's length, clamped to 0.5\u20132.0\u00d7).\n\nReturns JSON ``{audio_url, text, duration_s, id}`` \u2014 the take is saved to\nOUTPUTS_DIR and served from the ``/audio`` mount like every other take.",
"operationId": "convert_speech_convert_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_convert_speech_convert_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Convert Speech"
}
},
"/design/describe": {
"post": {
"description": "Parse a free-text description into design attrs + a validator-safe instruct.\n\nResponse shape::\n\n {\n \"attrs\": {\"Gender\": \"female\", \"Age\": \"elderly\", ... or \"Auto\"},\n \"instruct\": \"female, elderly, low pitch, british accent\",\n \"matched\": [{\"category\": \"Age\", \"token\": \"elderly\", \"phrase\": \"elderly\"}, ...],\n \"unmatched\": [\"slightly raspy\"]\n }",
"operationId": "describe_voice_design_describe_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Describe Voice Design Describe Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Describe Voice"
}
},
"/dictation/models": {
"get": {
"description": "The seven sherpa-onnx dictation models + install state.\n\nEach entry: id, repo_id, label, tag (\"offline\"|\"streaming\"), recommended,\nsize_gb, languages, kind, and install state (installed/installing). The\n``installed`` flag is computed from the same HF cache the model store reads,\nso it matches the model-store row state.",
"operationId": "list_dictation_models_dictation_models_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Dictation Models"
}
},
"/dictation/prefs": {
"get": {
"operationId": "get_dictation_prefs_dictation_prefs_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Dictation Prefs"
},
"post": {
"description": "Persist any subset of the dictation prefs. Validates ``mode``,\n``model_id`` and ``prompt`` so a bad value can't wedge the capture engine.\nAn empty ``prompt`` clears it.",
"operationId": "set_dictation_prefs_dictation_prefs_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictationPrefsUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Dictation Prefs"
}
},
"/dictation/readiness": {
"get": {
"description": "Check a selected ASR path without loading or downloading weights.",
"operationId": "dictation_readiness_dictation_readiness_get",
"parameters": [
{
"in": "query",
"name": "model_id",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
}
},
{
"in": "query",
"name": "purpose",
"required": false,
"schema": {
"default": "dictation",
"enum": [
"dictation",
"transcribe"
],
"title": "Purpose",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Dictation Readiness Dictation Readiness Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dictation Readiness"
}
},
"/dub/abort/{job_id}": {
"post": {
"description": "Cancel in-flight upload/transcribe subprocesses for a job.",
"operationId": "dub_abort_dub_abort__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Abort"
}
},
"/dub/agent-fit": {
"post": {
"description": "Rewrite rendered lines from real duration evidence.\n\nSynthesis stays in the normal Dubbing pipeline. The client renders each\ncandidate, measures it, and may request one more bounded correction.",
"operationId": "dub_agent_fit_dub_agent_fit_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentFitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Agent Fit"
}
},
"/dub/ass/{job_id}": {
"get": {
"description": "Karaoke ASS sidecar \u2014 the same script the karaoke burn-in renders.\n\nRaw text body like /dub/srt and /dub/vtt (the Tauri side writes the file\nitself; no ?save_path= variant \u2014 see the comment above /dub/srt).",
"operationId": "dub_export_ass_dub_ass__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"description": "Track language code. Same text/timing resolution as /dub/srt, rendered as a karaoke (word-highlight) ASS sidecar.",
"in": "query",
"name": "lang",
"required": false,
"schema": {
"description": "Track language code. Same text/timing resolution as /dub/srt, rendered as a karaoke (word-highlight) ASS sidecar.",
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Ass"
}
},
"/dub/ass/{job_id}/{filename}": {
"get": {
"description": "Karaoke ASS sidecar \u2014 the same script the karaoke burn-in renders.\n\nRaw text body like /dub/srt and /dub/vtt (the Tauri side writes the file\nitself; no ?save_path= variant \u2014 see the comment above /dub/srt).",
"operationId": "dub_export_ass_dub_ass__job_id___filename__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"description": "Track language code. Same text/timing resolution as /dub/srt, rendered as a karaoke (word-highlight) ASS sidecar.",
"in": "query",
"name": "lang",
"required": false,
"schema": {
"description": "Track language code. Same text/timing resolution as /dub/srt, rendered as a karaoke (word-highlight) ASS sidecar.",
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Ass"
}
},
"/dub/audio/{job_id}": {
"get": {
"operationId": "dub_get_audio_dub_audio__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Get Audio"
}
},
"/dub/cleanup-segments/{job_id}": {
"post": {
"description": "Re-run merge/stitch passes to drop fragments.\n\nCleans the editor's segments when sent, so unsaved text, timing and\ndirection edits survive; otherwise the job's stored segments. The\neditor's result is returned without being stored: it is an undoable edit\nlike any other, and the job keeps the segments its existing audio and\nsubtitle exports were generated from until the next generation.",
"operationId": "dub_cleanup_segments_dub_cleanup_segments__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/CleanupSegmentsRequest"
},
{
"type": "null"
}
],
"title": "Req"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Cleanup Segments"
}
},
"/dub/download-audio/{job_id}": {
"get": {
"operationId": "dub_download_audio_dub_download_audio__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
}
},
{
"in": "header",
"name": "X-VoiceStudio-Path-Authorization",
"required": false,
"schema": {
"default": "",
"title": "X-Voicestudio-Path-Authorization",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Download Audio"
}
},
"/dub/download-audio/{job_id}/{filename}": {
"get": {
"operationId": "dub_download_audio_dub_download_audio__job_id___filename__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
}
},
{
"in": "header",
"name": "X-VoiceStudio-Path-Authorization",
"required": false,
"schema": {
"default": "",
"title": "X-Voicestudio-Path-Authorization",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Download Audio"
}
},
"/dub/download-mp3/{job_id}": {
"get": {
"operationId": "dub_download_mp3_dub_download_mp3__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
}
},
{
"in": "query",
"name": "bitrate",
"required": false,
"schema": {
"default": "192k",
"title": "Bitrate",
"type": "string"
}
},
{
"in": "header",
"name": "X-VoiceStudio-Path-Authorization",
"required": false,
"schema": {
"default": "",
"title": "X-Voicestudio-Path-Authorization",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Download Mp3"
}
},
"/dub/download-mp3/{job_id}/{filename}": {
"get": {
"operationId": "dub_download_mp3_dub_download_mp3__job_id___filename__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
}
},
{
"in": "query",
"name": "bitrate",
"required": false,
"schema": {
"default": "192k",
"title": "Bitrate",
"type": "string"
}
},
{
"in": "header",
"name": "X-VoiceStudio-Path-Authorization",
"required": false,
"schema": {
"default": "",
"title": "X-Voicestudio-Path-Authorization",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Download Mp3"
}
},
"/dub/download/{job_id}": {
"get": {
"operationId": "dub_download_dub_download__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"description": "Mix background noise into dubbed tracks",
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"description": "Mix background noise into dubbed tracks",
"title": "Preserve Bg",
"type": "boolean"
}
},
{
"description": "Default audio track; omitted selects the first dubbed track",
"in": "query",
"name": "default_track",
"required": false,
"schema": {
"default": "",
"description": "Default audio track; omitted selects the first dubbed track",
"title": "Default Track",
"type": "string"
}
},
{
"description": "Comma-separated list of tracks to include (e.g. 'original,de,es'). Empty = include all.",
"in": "query",
"name": "include_tracks",
"required": false,
"schema": {
"default": "",
"description": "Comma-separated list of tracks to include (e.g. 'original,de,es'). Empty = include all.",
"title": "Include Tracks",
"type": "string"
}
},
{
"description": "Burn subtitles into the video stream (forces re-encode). Uses dual-subtitle layout when dual=1.",
"in": "query",
"name": "burn_subs",
"required": false,
"schema": {
"default": false,
"description": "Burn subtitles into the video stream (forces re-encode). Uses dual-subtitle layout when dual=1.",
"title": "Burn Subs",
"type": "boolean"
}
},
{
"description": "When burn_subs=1, render translated on top of italicised original.",
"in": "query",
"name": "dual",
"required": false,
"schema": {
"default": false,
"description": "When burn_subs=1, render translated on top of italicised original.",
"title": "Dual",
"type": "boolean"
}
},
{
"description": "When burn_subs=1, burn a word-timed karaoke highlight (ASS) instead of line subtitles. Ignored when dual=1 (dual karaoke is unsupported \u2014 the line burn renders instead).",
"in": "query",
"name": "karaoke",
"required": false,
"schema": {
"default": false,
"description": "When burn_subs=1, burn a word-timed karaoke highlight (ASS) instead of line subtitles. Ignored when dual=1 (dual karaoke is unsupported \u2014 the line burn renders instead).",
"title": "Karaoke",
"type": "boolean"
}
},
{
"description": "Audio-only jobs (#119): output container \u2014 wav, m4a, mp3, or flac. Ignored for video jobs.",
"in": "query",
"name": "out_format",
"required": false,
"schema": {
"default": "m4a",
"description": "Audio-only jobs (#119): output container \u2014 wav, m4a, mp3, or flac. Ignored for video jobs.",
"title": "Out Format",
"type": "string"
}
},
{
"in": "header",
"name": "X-VoiceStudio-Path-Authorization",
"required": false,
"schema": {
"default": "",
"title": "X-Voicestudio-Path-Authorization",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Download"
}
},
"/dub/download/{job_id}/{filename}": {
"get": {
"operationId": "dub_download_dub_download__job_id___filename__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"description": "Mix background noise into dubbed tracks",
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"description": "Mix background noise into dubbed tracks",
"title": "Preserve Bg",
"type": "boolean"
}
},
{
"description": "Default audio track; omitted selects the first dubbed track",
"in": "query",
"name": "default_track",
"required": false,
"schema": {
"default": "",
"description": "Default audio track; omitted selects the first dubbed track",
"title": "Default Track",
"type": "string"
}
},
{
"description": "Comma-separated list of tracks to include (e.g. 'original,de,es'). Empty = include all.",
"in": "query",
"name": "include_tracks",
"required": false,
"schema": {
"default": "",
"description": "Comma-separated list of tracks to include (e.g. 'original,de,es'). Empty = include all.",
"title": "Include Tracks",
"type": "string"
}
},
{
"description": "Burn subtitles into the video stream (forces re-encode). Uses dual-subtitle layout when dual=1.",
"in": "query",
"name": "burn_subs",
"required": false,
"schema": {
"default": false,
"description": "Burn subtitles into the video stream (forces re-encode). Uses dual-subtitle layout when dual=1.",
"title": "Burn Subs",
"type": "boolean"
}
},
{
"description": "When burn_subs=1, render translated on top of italicised original.",
"in": "query",
"name": "dual",
"required": false,
"schema": {
"default": false,
"description": "When burn_subs=1, render translated on top of italicised original.",
"title": "Dual",
"type": "boolean"
}
},
{
"description": "When burn_subs=1, burn a word-timed karaoke highlight (ASS) instead of line subtitles. Ignored when dual=1 (dual karaoke is unsupported \u2014 the line burn renders instead).",
"in": "query",
"name": "karaoke",
"required": false,
"schema": {
"default": false,
"description": "When burn_subs=1, burn a word-timed karaoke highlight (ASS) instead of line subtitles. Ignored when dual=1 (dual karaoke is unsupported \u2014 the line burn renders instead).",
"title": "Karaoke",
"type": "boolean"
}
},
{
"description": "Audio-only jobs (#119): output container \u2014 wav, m4a, mp3, or flac. Ignored for video jobs.",
"in": "query",
"name": "out_format",
"required": false,
"schema": {
"default": "m4a",
"description": "Audio-only jobs (#119): output container \u2014 wav, m4a, mp3, or flac. Ignored for video jobs.",
"title": "Out Format",
"type": "string"
}
},
{
"in": "header",
"name": "X-VoiceStudio-Path-Authorization",
"required": false,
"schema": {
"default": "",
"title": "X-Voicestudio-Path-Authorization",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Download"
}
},
"/dub/export-segments/{job_id}": {
"get": {
"operationId": "dub_export_segments_zip_dub_export_segments__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Segments Zip"
}
},
"/dub/export-stems/{job_id}": {
"get": {
"operationId": "dub_export_stems_dub_export_stems__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Stems"
}
},
"/dub/generate/{job_id}": {
"post": {
"description": "Adds a dub generation job to the async batch task pool.",
"operationId": "dub_generate_dub_generate__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas__requests__DubRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Generate"
}
},
"/dub/history": {
"delete": {
"description": "Delete persisted dub rows and their on-disk dirs (scoped to known IDs).",
"operationId": "clear_dub_history_dub_history_delete",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Clear Dub History"
},
"get": {
"operationId": "list_dub_history_dub_history_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Dub History"
}
},
"/dub/history/{history_id}": {
"delete": {
"operationId": "delete_single_dub_history_dub_history__history_id__delete",
"parameters": [
{
"in": "path",
"name": "history_id",
"required": true,
"schema": {
"title": "History Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Single Dub History"
}
},
"/dub/import-srt/{job_id}": {
"post": {
"description": "Replace `job[\"segments\"]` with timestamps + text parsed from an SRT\nfile. Used as a fallback when Whisper mis-transcribes \u2014 the user can\npoint at their own pre-synced subtitles and skip ASR entirely.\n\nReturns the new segment list plus counts of any cues we had to skip or\nre-time (overlap shifts). The caller surfaces these so the user knows\nif the import wasn't lossless.",
"operationId": "dub_import_srt_dub_import_srt__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_dub_import_srt_dub_import_srt__job_id__post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Import Srt"
}
},
"/dub/ingest-url": {
"post": {
"description": "Ingest a remote video URL via yt-dlp. Queues background prep task.\n\nReturns 202 immediately with {job_id, task_id}. All work (download,\naudio extract, Demucs, scene detect, thumbnail) happens in the background\ntask and progress is streamed via /tasks/stream/{task_id}.",
"operationId": "dub_ingest_url_dub_ingest_url_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DubIngestUrlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Ingest Url"
}
},
"/dub/media/{job_id}": {
"get": {
"operationId": "dub_get_media_dub_media__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Get Media"
},
"head": {
"operationId": "dub_get_media_dub_media__job_id__head",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Get Media"
}
},
"/dub/onsets/{job_id}": {
"get": {
"description": "Speech-onset times for the timeline editor's snap-to-onset ticks (#280).\n\nPrefers the Demucs-isolated vocals track (clean speech energy); falls\nback to the mixed audio. Computed once per job and cached as\n``onsets.json`` in the job directory; recomputed if the source audio is\nnewer than the cache (e.g. re-ingest into the same job dir).",
"operationId": "dub_get_onsets_dub_onsets__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Get Onsets"
}
},
"/dub/parse-subtitle-text": {
"post": {
"description": "Parse pasted subtitle text into timed cues. Stateless \u2014 no job, no I/O.\n\nA thin wrapper over `services.srt_parser.parse_srt` so the client's\n\"paste a translation\" flow reuses the exact lenient parser the .srt\nimport path uses (BOM / CRLF / `.`-vs-`,` ms / missing indices, plus\nde-overlapping). Unlike `/dub/import-srt/{job_id}` this mutates\nnothing: the caller maps these cues onto the segments it already has,\nkeeping the existing timings and `text_original`.",
"operationId": "dub_parse_subtitle_text_dub_parse_subtitle_text_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseSubtitleTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Parse Subtitle Text"
}
},
"/dub/preview-segment/{job_id}": {
"post": {
"description": "Generate TTS for a single segment and return WAV bytes.\n\nThis is the fast path for interactive editing \u2014 8 diffusion steps,\nno disk write, no mix. The preview IS synthetic audio leaving the app,\nso it carries the same invisible provenance mark as every other\nproducer (#1169 \u2014 \"no watermark\" here used to be an exemption).",
"operationId": "preview_segment_dub_preview_segment__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPreviewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Segment"
}
},
"/dub/preview-video/{job_id}": {
"get": {
"description": "Return an inline-playable MP4 with the chosen dubbed track as sole audio.\n\nCaches per lang+preserve_bg combination under exports/preview_{lang}_{bg}.mp4.\nCache is invalidated when the underlying dubbed track mtime is newer than the cache.",
"operationId": "dub_preview_video_dub_preview_video__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"description": "Language code of the dubbed track to mux in",
"in": "query",
"name": "lang",
"required": true,
"schema": {
"description": "Language code of the dubbed track to mux in",
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Preview Video"
},
"head": {
"description": "Return an inline-playable MP4 with the chosen dubbed track as sole audio.\n\nCaches per lang+preserve_bg combination under exports/preview_{lang}_{bg}.mp4.\nCache is invalidated when the underlying dubbed track mtime is newer than the cache.",
"operationId": "dub_preview_video_dub_preview_video__job_id__head",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"description": "Language code of the dubbed track to mux in",
"in": "query",
"name": "lang",
"required": true,
"schema": {
"description": "Language code of the dubbed track to mux in",
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "preserve_bg",
"required": false,
"schema": {
"default": true,
"title": "Preserve Bg",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Preview Video"
}
},
"/dub/preview/{job_id}/{segment_index}": {
"get": {
"operationId": "dub_preview_segment_dub_preview__job_id___segment_index__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "path",
"name": "segment_index",
"required": true,
"schema": {
"title": "Segment Index",
"type": "integer"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Preview Segment"
}
},
"/dub/prosody-mirror/{job_id}": {
"post": {
"description": "Suggest per-segment directions that mirror the source delivery.\n\nMeasures each line on the Demucs vocals track (the mix when separation\ndid not run) against its speaker's baseline and returns taxonomy\ndirections the editor can apply to lines without one. Read-only: nothing\nabout the job changes.",
"operationId": "dub_prosody_mirror_dub_prosody_mirror__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProsodyMirrorRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Prosody Mirror"
}
},
"/dub/qc/{job_id}": {
"post": {
"description": "Re-recognize the dubbed audio and flag lines whose recognized text\ndrifts from the target text. Opt-in, never fatal: the dub is untouched \u2014\nthis only annotates segments with a per-line drift score and a measured\nstart/end, surfaced as \"verify this line\" markers feeding incremental\nre-dub. The generated text stays authoritative (design delta from\npyvideotrans, which overwrites subtitles).",
"operationId": "dub_qc_pass_dub_qc__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": false,
"schema": {
"title": "Lang",
"type": "string"
}
},
{
"in": "query",
"name": "drift_threshold",
"required": false,
"schema": {
"default": 0.5,
"title": "Drift Threshold",
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Qc Pass"
}
},
"/dub/segments-text/{job_id}": {
"get": {
"description": "Per-segment texts for one generated track: ``{\"texts\": {segKey: text}}``.\n\nBacking store is ``job[\"segments_i18n\"]`` (P1.2) \u2014 the authoritative\nper-language map every generate rebuilds. The Export preview tabs use it\nto hydrate segments whose in-browser ``translations[lang]`` entry is\nmissing (tracks generated before per-language persistence, partial\nregens), so switching the preview language can't leave a mixed-language\ntranscript. Empty map when the job predates segments_i18n or the track\nwas never generated \u2014 the client keeps whatever it has.",
"operationId": "dub_segments_text_dub_segments_text__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"required": true,
"schema": {
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Segments Text"
}
},
"/dub/srt/{job_id}": {
"get": {
"operationId": "dub_export_srt_dub_srt__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "dual",
"required": false,
"schema": {
"default": false,
"title": "Dual",
"type": "boolean"
}
},
{
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"in": "query",
"name": "lang",
"required": false,
"schema": {
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Srt"
}
},
"/dub/srt/{job_id}/{filename}": {
"get": {
"operationId": "dub_export_srt_dub_srt__job_id___filename__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "dual",
"required": false,
"schema": {
"default": false,
"title": "Dual",
"type": "boolean"
}
},
{
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"in": "query",
"name": "lang",
"required": false,
"schema": {
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Srt"
}
},
"/dub/thumb/{job_id}": {
"get": {
"description": "Serve the extracted dub video thumbnail (jpg). 404 if not generated.",
"operationId": "dub_get_thumb_dub_thumb__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Get Thumb"
}
},
"/dub/tracks/{job_id}": {
"get": {
"operationId": "dub_list_tracks_dub_tracks__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub List Tracks"
}
},
"/dub/transcribe-stream/{job_id}": {
"get": {
"description": "Stream per-chunk segments via SSE, then emit diarized final pass.\n\nPre-flight checks (missing job, missing audio, ASR not loaded) are emitted\nas in-stream `error` events rather than HTTP errors, because EventSource\non the client can't read non-2xx response bodies \u2014 a 503 there surfaces\nas an opaque \"network error\" instead of the actionable message we want.\n\n`num_speakers` is an optional hint passed straight to pyannote. Left unset,\npyannote auto-detects the count \u2014 but its auto-detect can collapse a\nmulti-speaker clip to a single speaker (issue #274). When the user knows\nthe exact count, supplying it forces pyannote to return that many speakers.\nOn paths that can't honor the hint exactly (inline ASR turns, the\nsilence-gap heuristic) it is never silently dropped: the heuristic cycles\nthe requested count and a `warning` SSE event tells the user how far the\nlabels can be trusted.",
"operationId": "dub_transcribe_stream_dub_transcribe_stream__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "num_speakers",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Speakers"
}
},
{
"in": "query",
"name": "per_segment_refs",
"required": false,
"schema": {
"default": true,
"title": "Per Segment Refs",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Transcribe Stream"
}
},
"/dub/transcribe/{job_id}": {
"post": {
"description": "Legacy synchronous transcribe (kept for the headless CLI).\n\n`num_speakers` mirrors the SSE endpoint's query param (same 1\u201320 clamp):\nan exact speaker count forwarded to pyannote, or cycled by the silence-gap\nheuristic when pyannote is unavailable. None \u2192 auto-detect.",
"operationId": "dub_transcribe_dub_transcribe__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "num_speakers",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Speakers"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Transcribe"
}
},
"/dub/translate": {
"post": {
"operationId": "dub_translate_dub_translate_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TranslateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Translate"
}
},
"/dub/upload": {
"post": {
"description": "Accept a media upload, write to disk, queue background prep task.\n\n`input_type` is \"video\" (default) or \"audio\". Audio-only jobs (#119) skip\nscene detection, thumbnailing, and the final video mux \u2014 the transcribe \u2192\ntranslate \u2192 TTS core is identical.\n\nReturns 202 with {job_id, task_id, filename}. Client should open SSE on\n/tasks/stream/{task_id} to monitor extract/demucs stages and wait for the\n'ready' event before starting transcription.",
"operationId": "dub_upload_dub_upload_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_dub_upload_dub_upload_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Upload"
}
},
"/dub/use-downloaded-captions/{job_id}": {
"post": {
"description": "Seed a prepared Dub job from its downloaded caption track.",
"operationId": "dub_use_downloaded_captions_dub_use_downloaded_captions__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Use Downloaded Captions"
}
},
"/dub/vtt/{job_id}": {
"get": {
"operationId": "dub_export_vtt_dub_vtt__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "dual",
"required": false,
"schema": {
"default": false,
"title": "Dual",
"type": "boolean"
}
},
{
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"in": "query",
"name": "lang",
"required": false,
"schema": {
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Vtt"
}
},
"/dub/vtt/{job_id}/{filename}": {
"get": {
"operationId": "dub_export_vtt_dub_vtt__job_id___filename__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "dual",
"required": false,
"schema": {
"default": false,
"title": "Dual",
"type": "boolean"
}
},
{
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"in": "query",
"name": "lang",
"required": false,
"schema": {
"description": "Track language code. Emits that track's text (segments_i18n) when the job carries it; when that track was generated under Smart Fit or stretch_video, cue times come from the fitted timeline.",
"title": "Lang",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dub Export Vtt"
}
},
"/engines": {
"get": {
"operationId": "list_all_engines_engines_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List All Engines"
}
},
"/engines/asr": {
"get": {
"operationId": "list_asr_backends_engines_asr_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Asr Backends"
}
},
"/engines/audiocpp/runtime/install": {
"post": {
"operationId": "install_audiocpp_runtime_engines_audiocpp_runtime_install_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Install Audiocpp Runtime"
}
},
"/engines/audiocpp/runtime/install/status": {
"get": {
"operationId": "audiocpp_runtime_install_status_engines_audiocpp_runtime_install_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Audiocpp Runtime Install Status"
}
},
"/engines/diarisation": {
"get": {
"description": "Describe the selected local diarisation runtime without loading weights.",
"operationId": "diarisation_status_engines_diarisation_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Diarisation Status"
}
},
"/engines/diarisation/select": {
"post": {
"description": "Persist an installed diarisation runtime; environment overrides still win.",
"operationId": "select_diarisation_engine_engines_diarisation_select_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiarisationSelection"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Select Diarisation Engine"
}
},
"/engines/effects/presets": {
"get": {
"description": "Return available DSP effect presets for the dub pipeline.\n\nEach preset is a named chain of audio effects (EQ, compressor, reverb, etc.)\nthat can be applied to generated TTS audio on a per-segment basis.",
"operationId": "list_effects_presets_engines_effects_presets_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectPresetsResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "List Effects Presets"
}
},
"/engines/llm": {
"get": {
"operationId": "list_llm_backends_engines_llm_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Llm Backends"
}
},
"/engines/select": {
"post": {
"description": "Persist a family's engine pick to prefs.json. Refuses unknown backends,\nbackends whose deps aren't installed, AND backends that cannot run on THIS\nhost's hardware (routing_status == \"unavailable\") \u2014 so the UI can't silently\nbrick a pipeline by picking an engine that needs a GPU this machine lacks.\nA `cpu_fallback` pick is allowed (it runs, just slower) \u2014 only a hard\n`unavailable` is blocked. LLM is never routing-gated (its status is \"n/a\").",
"operationId": "select_engine_engines_select_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelectEngineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelectEngineResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Select Engine"
}
},
"/engines/sidecar/{engine_id}/install": {
"delete": {
"description": "Remove an app-managed sidecar install (checkout + venv + weights) and\nclear the persisted path. Refuses user-managed installs (a clone the user\nmade themselves) and installs with a job still running.",
"operationId": "uninstall_sidecar_engine_engines_sidecar__engine_id__install_delete",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Uninstall Sidecar Engine"
},
"post": {
"description": "Start (or report) the one-click install for a sidecar engine.\n\nReturns ``{status: \"started\"|\"already_running\"|\"already_installed\"}``.\n404 for engines that have no sidecar installer \u2014 the response names the\ntranslation-engine route so a mis-aimed client can self-correct.",
"operationId": "install_sidecar_engine_engines_sidecar__engine_id__install_post",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Install Sidecar Engine"
}
},
"/engines/sidecar/{engine_id}/install/status": {
"get": {
"description": "Step-by-step status of the sidecar install job (poll while running).\n\nShape: ``{engine_id, installed, managed, install_dir, job}`` where job is\nnull before the first run, else ``{state, steps[], log[], error,\nremediation, weights_progress, started_at, finished_at}``.",
"operationId": "sidecar_install_status_engines_sidecar__engine_id__install_status_get",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sidecar Install Status"
}
},
"/engines/sonitranslate/dub": {
"post": {
"description": "Run full dubbing pipeline via SoniTranslate.\n\nTranscribes, translates, generates TTS, and mixes audio.\nReturns the path to the dubbed output video.\n\nKNOWN PROVENANCE GAP (#1169, documented \u2014 not silently ignored): the\ndubbed audio is synthesized and muxed entirely inside the external\nSoniTranslate sidecar (its own venv + gradio pipeline, Edge-TTS voices),\nwhich hands back a finished video file. VoiceStudio's tensor-stage\nmark_synthetic chokepoint never sees that audio; marking it would require\na demux \u2192 embed \u2192 re-mux post-pass on the sidecar's output, which is a\nlossy re-encode of a pipeline we don't control. This opt-in engine\n(explicit install + start) is therefore NOT covered by the invisible\nAudioSeal provenance mark that every built-in synthesis path carries.",
"operationId": "sonitranslate_dub_engines_sonitranslate_dub_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api__routers__sonitranslate__DubRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sonitranslate Dub",
"tags": [
"SoniTranslate"
]
}
},
"/engines/sonitranslate/install": {
"post": {
"description": "Clone and set up SoniTranslate (heavy \u2014 ~15GB with models).",
"operationId": "sonitranslate_install_engines_sonitranslate_install_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Sonitranslate Install",
"tags": [
"SoniTranslate"
]
}
},
"/engines/sonitranslate/start": {
"post": {
"description": "Start the SoniTranslate Gradio server.",
"operationId": "sonitranslate_start_engines_sonitranslate_start_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Sonitranslate Start",
"tags": [
"SoniTranslate"
]
}
},
"/engines/sonitranslate/status": {
"get": {
"description": "Check SoniTranslate availability.",
"operationId": "sonitranslate_status_engines_sonitranslate_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Sonitranslate Status",
"tags": [
"SoniTranslate"
]
}
},
"/engines/sonitranslate/stop": {
"post": {
"description": "Stop the SoniTranslate Gradio server.",
"operationId": "sonitranslate_stop_engines_sonitranslate_stop_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Sonitranslate Stop",
"tags": [
"SoniTranslate"
]
}
},
"/engines/translation": {
"get": {
"description": "Translation engines with per-engine pip-package availability.\n\nSeparate from the tts/asr/llm \"family\" endpoints because these are\npip-installable on demand rather than select-from-what's-available.\nThe UI uses this to show a one-click Install chip when the user picks\nan engine whose Python dependency isn't importable yet.",
"operationId": "list_translation_engines_engines_translation_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Translation Engines"
}
},
"/engines/translation/argos/packs/install": {
"post": {
"operationId": "install_argos_packs_engines_translation_argos_packs_install_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArgosPackRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Install Argos Packs"
}
},
"/engines/translation/argos/packs/status": {
"post": {
"operationId": "argos_pack_status_engines_translation_argos_packs_status_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArgosPackRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Argos Pack Status"
}
},
"/engines/translation/select": {
"post": {
"operationId": "select_translation_engine_engines_translation_select_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TranslationSelection"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Select Translation Engine"
}
},
"/engines/translation/{engine_id}": {
"delete": {
"operationId": "uninstall_translation_engine_engines_translation__engine_id__delete",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Uninstall Translation Engine"
}
},
"/engines/translation/{engine_id}/install": {
"post": {
"operationId": "install_translation_engine_engines_translation__engine_id__install_post",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Install Translation Engine"
}
},
"/engines/tts": {
"get": {
"operationId": "list_tts_backends_engines_tts_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Tts Backends"
}
},
"/engines/{engine_id}/disk-usage": {
"get": {
"description": "Measure owned engine bytes only when a catalogue row is opened.",
"operationId": "engine_disk_usage_engines__engine_id__disk_usage_get",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Engine Disk Usage"
}
},
"/engines/{engine_id}/health": {
"get": {
"description": "Spawn-and-ping a SubprocessBackend; ``is_available()`` for the rest.\n\nReturns:\n { id, ok, message, latency_ms }\n\n Never raises through to a 500: backend diagnostics stay in the local\n log and the response carries a fixed failure message, so the UI can\n render a per-row failure without exposing private data. Unknown engine\n ids return 404.",
"operationId": "engine_health_engines__engine_id__health_get",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Engine Health"
}
},
"/engines/{engine_id}/selftest": {
"post": {
"description": "Run a bounded, real synthesis on an available in-process TTS engine.\n\n404 for an unknown TTS id; 400 when the engine is subprocess-isolated or\nnot currently available (a real synth on either is meaningless). Never\nraises through to a 500 on a synth failure \u2014 the exception is captured into\n``ok=False`` / ``message`` so the panel renders a per-row failure.",
"operationId": "engine_selftest_engines__engine_id__selftest_post",
"parameters": [
{
"in": "path",
"name": "engine_id",
"required": true,
"schema": {
"title": "Engine Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfTestResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Engine Selftest"
}
},
"/export": {
"post": {
"operationId": "export_file_export_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export File"
}
},
"/export/history": {
"get": {
"operationId": "get_export_history_export_history_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Export History"
}
},
"/export/history/{export_id}": {
"delete": {
"description": "Forget an export record without touching its source or destination file.",
"operationId": "delete_export_history_export_history__export_id__delete",
"parameters": [
{
"in": "path",
"name": "export_id",
"required": true,
"schema": {
"title": "Export Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Export History"
}
},
"/export/record": {
"post": {
"operationId": "record_export_export_record_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Record Export"
}
},
"/export/reveal": {
"post": {
"operationId": "reveal_in_folder_export_reveal_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevealRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Reveal In Folder"
}
},
"/gallery/categories": {
"get": {
"description": "List all voice gallery categories.",
"operationId": "list_categories_gallery_categories_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Categories"
}
},
"/gallery/download": {
"post": {
"description": "Download a clip from YouTube for voice cloning.",
"operationId": "download_youtube_clip_gallery_download_post",
"parameters": [
{
"description": "YouTube video URL",
"in": "query",
"name": "video_url",
"required": true,
"schema": {
"description": "YouTube video URL",
"title": "Video Url",
"type": "string"
}
},
{
"description": "Start time in seconds",
"in": "query",
"name": "start_time",
"required": false,
"schema": {
"default": 0,
"description": "Start time in seconds",
"minimum": 0,
"title": "Start Time",
"type": "number"
}
},
{
"description": "Clip duration in seconds",
"in": "query",
"name": "duration",
"required": false,
"schema": {
"default": 10,
"description": "Clip duration in seconds",
"maximum": 30,
"minimum": 1,
"title": "Duration",
"type": "number"
}
},
{
"description": "Name to label this clip",
"in": "query",
"name": "character_name",
"required": true,
"schema": {
"description": "Name to label this clip",
"title": "Character Name",
"type": "string"
}
},
{
"description": "Free-form tag stored with the clip",
"in": "query",
"name": "category",
"required": false,
"schema": {
"default": "import",
"description": "Free-form tag stored with the clip",
"title": "Category",
"type": "string"
}
},
{
"description": "Optional description",
"in": "query",
"name": "description",
"required": false,
"schema": {
"default": "",
"description": "Optional description",
"title": "Description",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Download Youtube Clip"
}
},
"/gallery/search/youtube": {
"post": {
"description": "Search a source site (via yt-dlp) for clips matching the user's query.\n\nThe query is user-supplied; the project ships no celebrity/character seed\nlist. Users are responsible for the licensing of whatever they import.",
"operationId": "search_youtube_gallery_search_youtube_post",
"parameters": [
{
"description": "User-supplied search terms or video title",
"in": "query",
"name": "query",
"required": true,
"schema": {
"description": "User-supplied search terms or video title",
"title": "Query",
"type": "string"
}
},
{
"description": "Free-form tag stored with results",
"in": "query",
"name": "category",
"required": false,
"schema": {
"default": "import",
"description": "Free-form tag stored with results",
"title": "Category",
"type": "string"
}
},
{
"in": "query",
"name": "max_results",
"required": false,
"schema": {
"default": 5,
"maximum": 20,
"minimum": 1,
"title": "Max Results",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Search Youtube"
}
},
"/gallery/upload": {
"post": {
"description": "Upload a voice clip directly to the gallery.",
"operationId": "upload_voice_clip_gallery_upload_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_voice_clip_gallery_upload_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Upload Voice Clip"
}
},
"/gallery/voices": {
"get": {
"description": "List voices in the gallery, optionally filtered by category or search.",
"operationId": "list_voices_gallery_voices_get",
"parameters": [
{
"description": "Filter by category",
"in": "query",
"name": "category",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filter by category",
"title": "Category"
}
},
{
"description": "Search by name or character",
"in": "query",
"name": "search",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Search by name or character",
"title": "Search"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Voices"
}
},
"/gallery/voices/batch-delete": {
"post": {
"description": "Delete multiple voices by ID list.",
"operationId": "batch_delete_voices_gallery_voices_batch_delete_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Body",
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Batch Delete Voices"
}
},
"/gallery/voices/{voice_id}": {
"delete": {
"description": "Delete a voice from the gallery.",
"operationId": "delete_voice_gallery_voices__voice_id__delete",
"parameters": [
{
"in": "path",
"name": "voice_id",
"required": true,
"schema": {
"title": "Voice Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Voice"
},
"get": {
"description": "Get a specific voice from the gallery.",
"operationId": "get_voice_gallery_voices__voice_id__get",
"parameters": [
{
"in": "path",
"name": "voice_id",
"required": true,
"schema": {
"title": "Voice Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Voice"
},
"patch": {
"description": "Update voice metadata \u2014 name, tags, is_favorite.",
"operationId": "update_voice_gallery_voices__voice_id__patch",
"parameters": [
{
"in": "path",
"name": "voice_id",
"required": true,
"schema": {
"title": "Voice Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Body",
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Voice"
}
},
"/gallery/voices/{voice_id}/preview": {
"get": {
"description": "Get a voice clip for preview playback.",
"operationId": "preview_voice_gallery_voices__voice_id__preview_get",
"parameters": [
{
"in": "path",
"name": "voice_id",
"required": true,
"schema": {
"title": "Voice Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Voice"
}
},
"/gallery/voices/{voice_id}/save-as-profile": {
"post": {
"description": "Save a gallery voice as a voice profile for cloning.",
"operationId": "save_voice_as_profile_gallery_voices__voice_id__save_as_profile_post",
"parameters": [
{
"in": "path",
"name": "voice_id",
"required": true,
"schema": {
"title": "Voice Id",
"type": "string"
}
},
{
"description": "Name for the voice profile",
"in": "query",
"name": "profile_name",
"required": true,
"schema": {
"description": "Name for the voice profile",
"title": "Profile Name",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Save Voice As Profile"
}
},
"/gallery/voices/{voice_id}/to-profile": {
"post": {
"description": "Create a voice profile from a gallery clip.",
"operationId": "voice_to_profile_gallery_voices__voice_id__to_profile_post",
"parameters": [
{
"in": "path",
"name": "voice_id",
"required": true,
"schema": {
"title": "Voice Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Voice To Profile"
}
},
"/generate": {
"post": {
"operationId": "generate_speech_generate_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_generate_speech_generate_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generate Speech"
}
},
"/generate/budget": {
"get": {
"description": "Active generate budgets, so the UI's backstop follows operator overrides.\n\n``engine`` (default: the active engine) selects the local route the\nCPU-ceiling hint is reported for.",
"operationId": "generate_budget_generate_budget_get",
"parameters": [
{
"in": "query",
"name": "engine",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generate Budget"
}
},
"/glossary/{project_id}": {
"delete": {
"description": "Clear every term. `only_auto=true` keeps user-added entries.",
"operationId": "clear_terms_glossary__project_id__delete",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
},
{
"in": "query",
"name": "only_auto",
"required": false,
"schema": {
"default": false,
"title": "Only Auto",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Terms"
},
"get": {
"operationId": "list_terms_glossary__project_id__get",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Terms"
},
"post": {
"operationId": "add_term_glossary__project_id__post",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlossaryTerm"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Add Term"
}
},
"/glossary/{project_id}/auto-extract": {
"post": {
"description": "Ask the LLM to propose glossary entries from the project's source segments.\n\nWrites them as `auto=1` rows. Existing terms with the same (source,target)\nare NOT duplicated. Returns the full current glossary after the pass.",
"operationId": "auto_extract_glossary__project_id__auto_extract_post",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoExtractRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Auto Extract"
}
},
"/glossary/{project_id}/{term_id}": {
"delete": {
"operationId": "delete_term_glossary__project_id___term_id__delete",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
},
{
"in": "path",
"name": "term_id",
"required": true,
"schema": {
"title": "Term Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Term"
},
"put": {
"operationId": "update_term_glossary__project_id___term_id__put",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
},
{
"in": "path",
"name": "term_id",
"required": true,
"schema": {
"title": "Term Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlossaryTermUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Term"
}
},
"/health": {
"get": {
"operationId": "health_health_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Health"
}
},
"/history": {
"delete": {
"operationId": "clear_history_history_delete",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Clear History"
},
"get": {
"description": "The newest 50 generations plus every starred take, newest first, kept to\nrows whose audio still exists on disk.\n\nStarred takes ride along past the 50-row window so a keeper can never age\noff the rail. Rows whose WAV was deleted out-of-band (cleared outputs dir,\nmanual cleanup) used to come back anyway and render dead players that 404\non every fetch; prune them here so the UI never sees them again.",
"operationId": "list_history_history_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List History"
}
},
"/history/{history_id}": {
"delete": {
"operationId": "delete_single_history_history__history_id__delete",
"parameters": [
{
"in": "path",
"name": "history_id",
"required": true,
"schema": {
"title": "History Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Single History"
}
},
"/history/{history_id}/starred": {
"put": {
"description": "Star/unstar a take. Starred takes survive the retention cap and always\nappear in GET /history regardless of the recency window.",
"operationId": "set_history_starred_history__history_id__starred_put",
"parameters": [
{
"in": "path",
"name": "history_id",
"required": true,
"schema": {
"title": "History Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_StarBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set History Starred"
}
},
"/jobs": {
"get": {
"description": "List persisted jobs, newest first.\n\n`status=active` \u2192 running + pending (what the batch-queue UI wants).\n`status=failed|done|cancelled|pending|running` \u2192 exact match.\n`project_id=...` \u2192 scope to one project.",
"operationId": "list_jobs_jobs_get",
"parameters": [
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"in": "query",
"name": "project_id",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Jobs"
}
},
"/jobs/{job_id}": {
"get": {
"operationId": "get_job_jobs__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Job"
}
},
"/jobs/{job_id}/events": {
"get": {
"description": "Persisted SSE tail. Strict ascending seq so the client can stitch\nit onto a live feed (which starts above the last returned seq).",
"operationId": "list_job_events_jobs__job_id__events_get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "after_seq",
"required": false,
"schema": {
"default": 0,
"title": "After Seq",
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 500,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Job Events"
}
},
"/longform/jobs": {
"get": {
"description": "Finished Audiobook + Story renders, newest-first, ready to re-download.\n\n Each item's ``output`` is served at ``/audio/<output>``. Never 500s \u2014 on any\n backend hiccup it returns an empty list rather than an error.\n\n ``job_store`` is bound at module import (top of file), NOT re-imported\n here at call time. A call-time ``from api.dependencies import require_loopback\nfrom core import job_store`` re-resolves\n through ``sys.modules`` on every request \u2014 and several test suites purge\n and re-import the whole ``core``/``services`` namespace under a\n temporary OMNIVOICE_DATA_DIR (the ``isolated_db`` pattern,\n tests/smoke/test_boot_smoke.py, \u2026) without restoring the old module\n tree. After one of those ran, the call-time import resolved a stale\n module world whose DB_PATH pointed at a different SQLite file than the\n one the test seeded through its collection-time bindings, so the library\n came back without the seeded jobs (the order-dependent\n test_route_handler_returns_jobs_envelope full-suite flake). The\n module-level binding keeps this route in the same world as whoever\n imported this module. Regression:\n tests/test_longform_jobs.py::test_route_survives_leaked_module_world_purge.",
"operationId": "longform_jobs_longform_jobs_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Longform Jobs Longform Jobs Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Longform Jobs"
}
},
"/longform/jobs/{job_id}": {
"delete": {
"description": "Remove a finished library record and its events, preserving render audio.",
"operationId": "delete_longform_job_longform_jobs__job_id__delete",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Delete Longform Job Longform Jobs Job Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Longform Job"
}
},
"/longform/render": {
"post": {
"description": "Render a pre-built chapter/span plan (the Stories Editor's compiled\ncast+lines) through the shared chapterized renderer \u2014 same resume, loudness,\ncover, metadata, and output formats as the Audiobook job.",
"operationId": "longform_render_longform_render_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LongformRenderRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Longform Render"
}
},
"/marketplace/browse": {
"get": {
"description": "List available .omnivoice bundles in the local marketplace directory.",
"operationId": "browse_marketplace_marketplace_browse_get",
"parameters": [
{
"description": "Search by name or tags",
"in": "query",
"name": "search",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Search by name or tags",
"title": "Search"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Browse Marketplace",
"tags": [
"Voice Marketplace"
]
}
},
"/marketplace/export/{profile_id}": {
"post": {
"description": "Export a voice profile as a downloadable .omnivoice bundle (ZIP).",
"operationId": "export_profile_marketplace_export__profile_id__post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export Profile",
"tags": [
"Voice Marketplace"
]
}
},
"/marketplace/import": {
"post": {
"description": "Import a voice profile from a .omnivoice bundle.",
"operationId": "import_profile_marketplace_import_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_import_profile_marketplace_import_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Import Profile",
"tags": [
"Voice Marketplace"
]
}
},
"/marketplace/install/{filename}": {
"post": {
"description": "Import a voice profile from a bundle in the local marketplace directory.",
"operationId": "install_from_marketplace_marketplace_install__filename__post",
"parameters": [
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"title": "Filename",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Install From Marketplace",
"tags": [
"Voice Marketplace"
]
}
},
"/marketplace/publish/{profile_id}": {
"post": {
"description": "Publish a voice profile to the local marketplace directory.\n\nThis saves a .omnivoice bundle to the marketplace folder so other\nVoiceStudio instances on the same machine (or shared network drive)\ncan discover and import it.",
"operationId": "publish_to_marketplace_marketplace_publish__profile_id__post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
},
{
"description": "Comma-separated tags",
"in": "query",
"name": "tags",
"required": false,
"schema": {
"default": "",
"description": "Comma-separated tags",
"title": "Tags",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Publish To Marketplace",
"tags": [
"Voice Marketplace"
]
}
},
"/marketplace/{filename}": {
"delete": {
"description": "Remove a bundle from the local marketplace directory.",
"operationId": "remove_from_marketplace_marketplace__filename__delete",
"parameters": [
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"title": "Filename",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove From Marketplace",
"tags": [
"Voice Marketplace"
]
}
},
"/media-tools/acquire": {
"post": {
"description": "(Re-)fetch the pinned, checksummed static ffmpeg/ffprobe build in the\nbackground. Idempotent; poll /media-tools/status for progress.",
"operationId": "media_tools_acquire_media_tools_acquire_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Media Tools Acquire"
}
},
"/media-tools/status": {
"get": {
"description": "Per-tool {ok, path, version, origin} + background-op states.",
"operationId": "media_tools_status_media_tools_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Media Tools Status"
}
},
"/media-tools/ytdlp/restore": {
"post": {
"description": "Drop the overlay \u2014 the app-tested, locked yt-dlp takes over on next\nstart. Always safe (the locked install is never modified).",
"operationId": "media_tools_ytdlp_restore_media_tools_ytdlp_restore_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Media Tools Ytdlp Restore"
}
},
"/media-tools/ytdlp/update": {
"post": {
"description": "Fetch the newest yt-dlp wheel (sha256-verified against PyPI metadata)\ninto the update-surviving overlay. Applies on next backend start.",
"operationId": "media_tools_ytdlp_update_media_tools_ytdlp_update_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Media Tools Ytdlp Update"
}
},
"/media-tools/{tool}/custom-path": {
"post": {
"operationId": "media_tools_custom_path_media_tools__tool__custom_path_post",
"parameters": [
{
"in": "path",
"name": "tool",
"required": true,
"schema": {
"title": "Tool",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomPathRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Media Tools Custom Path"
}
},
"/media-tools/{tool}/restore": {
"post": {
"operationId": "media_tools_restore_media_tools__tool__restore_post",
"parameters": [
{
"in": "path",
"name": "tool",
"required": true,
"schema": {
"title": "Tool",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Media Tools Restore"
}
},
"/media-tools/{tool}/use-system": {
"post": {
"operationId": "media_tools_use_system_media_tools__tool__use_system_post",
"parameters": [
{
"in": "path",
"name": "tool",
"required": true,
"schema": {
"title": "Tool",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Media Tools Use System"
}
},
"/model/loaded": {
"get": {
"description": "List all currently loaded models for the flush dropdown (MM2-04).\nThin delegation to the model_lifecycle facade \u2014 shape unchanged:\n``{models, count}``.",
"operationId": "loaded_models_model_loaded_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Loaded Models"
}
},
"/model/status": {
"get": {
"description": "Report model loading state for frontend warm-up indicators.",
"operationId": "model_status_model_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelStatusResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "Model Status"
}
},
"/model/unload/{model_id}": {
"post": {
"description": "Unload a specific model by id (MM2-04). Delegates to model_lifecycle;\nan unknown id maps to HTTP 400. Supports every id returned by\n``GET /model/loaded`` plus the aggregate ``sidecars`` id.",
"operationId": "unload_model_model_unload__model_id__post",
"parameters": [
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"title": "Model Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Unload Model"
}
},
"/models": {
"get": {
"description": "Catalogue every known model + its on-disk install state.\n\nUses a 10 s response cache to avoid repeated ``scan_cache_dir()`` disk\nwalks when the frontend polls.",
"operationId": "list_models_models_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Models"
}
},
"/models/access/status": {
"get": {
"description": "Check gated Hub access without downloading model files.\n\nThis route runs only after an explicit UI action. It never returns the\ntoken or a raw Hub exception; callers need only the per-repository verdict.",
"operationId": "model_access_status_models_access_status_get",
"parameters": [
{
"in": "query",
"name": "repo_id",
"required": true,
"schema": {
"title": "Repo Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Model Access Status"
}
},
"/models/install": {
"post": {
"description": "Download one HF repo snapshot; progress goes through the shared\n``/setup/download-stream`` SSE feed.",
"operationId": "install_model_models_install_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallModelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Install Model"
}
},
"/models/install/cancel": {
"post": {
"description": "Request cancellation of an in-flight install (FDL-11).\n\nBest-effort: stops further retry attempts and marks the row cancelled. A\nsingle in-flight snapshot_download/Xet fetch isn't interruptible mid-file\nin hf_hub 1.7.2, so an already-streaming file finishes; the cancel takes\neffect at the next retry boundary. Clears the cooldown so the user can\nimmediately restart.",
"operationId": "cancel_install_models_install_cancel_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallModelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Install"
}
},
"/models/install/commit": {
"post": {
"description": "Persist acknowledgement before a bounded exact-file reviewed transfer.\n\nThis synchronous endpoint runs in FastAPI's worker threadpool. Failed transfer\nretains the exact receipt for retry and never invokes the ordinary installer.\nNo reviewed production rows are currently enabled. Upstream gated access and\nworker review need their own verified protocol before those rows can be ready.",
"operationId": "commit_model_install_models_install_commit_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Commit Model Install Models Install Commit Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Commit Model Install"
}
},
"/models/install/prepare": {
"post": {
"description": "Read bundled evidence only; never resolve/download model weights.",
"operationId": "prepare_model_install_models_install_prepare_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrepareRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Prepare Model Install Models Install Prepare Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Prepare Model Install"
}
},
"/models/install/status": {
"get": {
"description": "Read local jobs after navigation without starting downloads.",
"operationId": "model_install_status_models_install_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Model Install Status"
}
},
"/models/licenses/accept": {
"post": {
"description": "Record that the user confirmed they hold the rights these exact terms require.",
"operationId": "accept_model_licence_models_licenses_accept_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Accept Model Licence Models Licenses Accept Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Accept Model Licence"
}
},
"/models/licenses/acceptance/{repo_id}": {
"get": {
"operationId": "get_model_licence_acceptance_models_licenses_acceptance__repo_id__get",
"parameters": [
{
"in": "path",
"name": "repo_id",
"required": true,
"schema": {
"title": "Repo Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Model Licence Acceptance Models Licenses Acceptance Repo Id Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Model Licence Acceptance"
}
},
"/models/licenses/details/{repo_id}": {
"get": {
"description": "Licence disclosure, acceptance state and acceptance history for one model.",
"operationId": "get_model_licence_details_models_licenses_details__repo_id__get",
"parameters": [
{
"in": "path",
"name": "repo_id",
"required": true,
"schema": {
"title": "Repo Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Model Licence Details Models Licenses Details Repo Id Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Model Licence Details"
}
},
"/models/licenses/receipts/{plan_digest}": {
"delete": {
"description": "Remove local acknowledgement only; keep files and historical evidence.",
"operationId": "remove_model_receipt_models_licenses_receipts__plan_digest__delete",
"parameters": [
{
"in": "path",
"name": "plan_digest",
"required": true,
"schema": {
"title": "Plan Digest",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Remove Model Receipt Models Licenses Receipts Plan Digest Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove Model Receipt"
},
"get": {
"description": "Export one local receipt and its exact archived evidence; no network.",
"operationId": "export_model_receipt_models_licenses_receipts__plan_digest__get",
"parameters": [
{
"in": "path",
"name": "plan_digest",
"required": true,
"schema": {
"title": "Plan Digest",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Export Model Receipt Models Licenses Receipts Plan Digest Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export Model Receipt"
}
},
"/models/licenses/revoke": {
"post": {
"operationId": "revoke_model_licence_models_licenses_revoke_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevokeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Revoke Model Licence Models Licenses Revoke Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke Model Licence"
}
},
"/models/licenses/verify/{plan_digest}": {
"post": {
"description": "Explicit verification helper; legacy first-use/SDKs do not yet call it.",
"operationId": "verify_model_install_models_licenses_verify__plan_digest__post",
"parameters": [
{
"in": "path",
"name": "plan_digest",
"required": true,
"schema": {
"title": "Plan Digest",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Verify Model Install Models Licenses Verify Plan Digest Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Verify Model Install"
}
},
"/models/{repo_id}": {
"delete": {
"description": "Remove every cached revision of a repo from the HF cache.",
"operationId": "delete_model_models__repo_id__delete",
"parameters": [
{
"in": "path",
"name": "repo_id",
"required": true,
"schema": {
"title": "Repo Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Model"
}
},
"/personalities": {
"get": {
"description": "Return built-in voice personality presets.",
"operationId": "list_personalities_personalities_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Personalities"
}
},
"/personas/export/{profile_id}": {
"post": {
"description": "Build + stream a `.ovsvoice` bundle for a profile.",
"operationId": "export_persona_personas_export__profile_id__post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
},
{
"in": "query",
"name": "license_spdx",
"required": false,
"schema": {
"default": "LicenseRef-VoiceStudio-Personal",
"title": "License Spdx",
"type": "string"
}
},
{
"in": "query",
"name": "tags",
"required": false,
"schema": {
"default": "",
"title": "Tags",
"type": "string"
}
},
{
"in": "query",
"name": "include_reference",
"required": false,
"schema": {
"default": true,
"title": "Include Reference",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export Persona"
}
},
"/personas/import": {
"post": {
"description": "Create a new voice profile from a `.ovsvoice` (or legacy `.omnivoice`) bundle.",
"operationId": "import_persona_personas_import_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_import_persona_personas_import_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Import Persona"
}
},
"/personas/inspect": {
"post": {
"description": "Read a bundle's manifest + consent summary WITHOUT writing any file or row.",
"operationId": "inspect_persona_personas_inspect_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_inspect_persona_personas_inspect_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Inspect Persona"
}
},
"/preview/upload": {
"post": {
"operationId": "preview_upload_preview_upload_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_preview_upload_preview_upload_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Upload"
}
},
"/preview/{filename}": {
"get": {
"operationId": "preview_serve_preview__filename__get",
"parameters": [
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"title": "Filename",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Serve"
}
},
"/profile-images/search": {
"get": {
"operationId": "search_profile_images_profile_images_search_get",
"parameters": [
{
"in": "query",
"name": "name",
"required": true,
"schema": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Search Profile Images"
}
},
"/profiles": {
"get": {
"operationId": "list_profiles_profiles_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Profiles"
},
"post": {
"description": "Create a voice profile (spec: docs/specs/voice-studio-unification.md \u00a75).\n\nkind='clone' \u2014 requires `ref_audio` (the user's reference recording).\nkind='design' \u2014 requires `vd_states` (JSON of category picks); the server\n renders a deterministic sample WAV (seed 42, same path as\n archetype materialization) and stores it as the profile's\n reference so the voice identity is stable across runs.",
"operationId": "create_profile_profiles_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_profile_profiles_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Profile"
}
},
"/profiles/{profile_id}": {
"delete": {
"operationId": "delete_profile_profiles__profile_id__delete",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Profile"
},
"get": {
"description": "Full profile record for the voice profile page.",
"operationId": "get_profile_profiles__profile_id__get",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Profile"
},
"put": {
"description": "Partial update \u2014 only fields set on the payload are changed.",
"operationId": "update_profile_profiles__profile_id__put",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Profile"
}
},
"/profiles/{profile_id}/attestation": {
"delete": {
"operationId": "clear_attestation_profiles__profile_id__attestation_delete",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Attestation"
},
"post": {
"description": "Record \"This is my voice\" / \"I have the speaker's permission\" (sync consent, S2).",
"operationId": "attest_consent_profiles__profile_id__attestation_post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttestationBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Attest Consent"
}
},
"/profiles/{profile_id}/audio": {
"get": {
"operationId": "get_profile_audio_profiles__profile_id__audio_get",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Profile Audio"
},
"put": {
"description": "Replace a saved clone's reference clip in place (#2282).\n\nThe profile keeps its id, portrait and history. Optional ``name``,\n``instruct``, ``language`` and ``personality`` are saved in the same\nUPDATE, so an editor save commits every change or none. The clip is\nwritten under a NEW versioned filename (``{id}-{token}{ext}``) rather\nthan overwritten: engine prompt caches, prepared-reference caches and\nchapter render caches are keyed by the reference path, so a new name\ninvalidates all of them at once. Because the new clip may be a different\nspeaker, a locked take and own-voice consent no longer describe this voice\nand are cleared. The previous files are removed only after the database\ncommits; any failure before that removes the new file instead.",
"operationId": "replace_profile_audio_profiles__profile_id__audio_put",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_replace_profile_audio_profiles__profile_id__audio_put"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Replace Profile Audio"
}
},
"/profiles/{profile_id}/consent": {
"delete": {
"operationId": "revoke_consent_profiles__profile_id__consent_delete",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke Consent"
},
"post": {
"operationId": "record_consent_profiles__profile_id__consent_post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_record_consent_profiles__profile_id__consent_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Record Consent"
}
},
"/profiles/{profile_id}/image": {
"get": {
"operationId": "get_profile_image_profiles__profile_id__image_get",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Profile Image"
},
"put": {
"operationId": "update_profile_image_profiles__profile_id__image_put",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_update_profile_image_profiles__profile_id__image_put"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Profile Image"
}
},
"/profiles/{profile_id}/lock": {
"post": {
"operationId": "lock_profile_profiles__profile_id__lock_post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_lock_profile_profiles__profile_id__lock_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Lock Profile"
}
},
"/profiles/{profile_id}/unlock": {
"post": {
"operationId": "unlock_profile_profiles__profile_id__unlock_post",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Unlock Profile"
}
},
"/profiles/{profile_id}/usage": {
"get": {
"description": "Where has this voice been used? Synth-history + segment counts per project.",
"operationId": "get_profile_usage_profiles__profile_id__usage_get",
"parameters": [
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"title": "Profile Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Profile Usage"
}
},
"/projects": {
"get": {
"operationId": "list_projects_projects_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Projects"
},
"post": {
"operationId": "create_project_projects_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSaveRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Project"
}
},
"/projects/{project_id}": {
"delete": {
"operationId": "delete_project_projects__project_id__delete",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Project"
},
"get": {
"operationId": "get_project_projects__project_id__get",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Project"
},
"patch": {
"description": "Lightweight rename \u2014 updates only the project name (and updated_at),\nwithout re-serialising the whole state blob like PUT does.",
"operationId": "rename_project_projects__project_id__patch",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRenameRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Rename Project"
},
"put": {
"operationId": "update_project_projects__project_id__put",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"title": "Project Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSaveRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Project"
}
},
"/pronunciation": {
"get": {
"operationId": "list_entries_pronunciation_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Entries"
},
"post": {
"operationId": "create_entry_pronunciation_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PronEntry"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Entry"
}
},
"/pronunciation/export": {
"get": {
"description": "Every entry as a JSON-serializable list (round-trips ``/import``).",
"operationId": "export_entries_pronunciation_export_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Export Entries"
}
},
"/pronunciation/import": {
"post": {
"description": "Bulk-add entries. ``replace=true`` clears the table first.\n\nEach entry is validated like ``POST /pronunciation``; one bad row fails the\nwhole import (400) so the table is never left half-applied.",
"operationId": "import_entries_pronunciation_import_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PronImportRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Import Entries"
}
},
"/pronunciation/test": {
"post": {
"description": "Show the post-substitution text for ``req.text`` \u2014 no model call.\n\nApplies the same dictionary + inline ``[[\u2026]]`` resolution the synth path\nruns, so the user sees exactly what the engine will be handed.",
"operationId": "test_substitution_pronunciation_test_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PronTestRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Test Substitution"
}
},
"/pronunciation/{entry_id}": {
"delete": {
"operationId": "delete_entry_pronunciation__entry_id__delete",
"parameters": [
{
"in": "path",
"name": "entry_id",
"required": true,
"schema": {
"title": "Entry Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Entry"
},
"put": {
"operationId": "update_entry_pronunciation__entry_id__put",
"parameters": [
{
"in": "path",
"name": "entry_id",
"required": true,
"schema": {
"title": "Entry Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PronEntryUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Entry"
}
},
"/setup/download-stream": {
"get": {
"description": "SSE: forward every HuggingFace download tqdm update as a JSON event.",
"operationId": "setup_download_stream_setup_download_stream_get",
"parameters": [
{
"in": "query",
"name": "target",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Setup Download Stream"
}
},
"/setup/preflight": {
"get": {
"description": "One-shot system health check for the wizard.",
"operationId": "preflight_setup_preflight_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreflightResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "Preflight"
}
},
"/setup/recommendations": {
"get": {
"description": "Return a curated model preset for the caller's device + architecture.\n\nData-driven from the ``curated_on`` field in models.yaml \u2014 adding or\nretargeting a curated pick is a catalog edit, not a code change. Only the\nTTS model is required; the ASR picks here are the optional \"best for your\nsystem\" set the wizard and Settings surface for on-demand install.",
"operationId": "recommendations_setup_recommendations_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Recommendations"
}
},
"/setup/status": {
"get": {
"description": "Snapshot the setup state so the client can pick its boot screen.",
"operationId": "setup_status_setup_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetupStatusResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "Setup Status"
}
},
"/setup/warmup": {
"post": {
"description": "Trigger a model load in the background so the first dub doesn't pay\nthe cold-start tax.",
"operationId": "setup_warmup_setup_warmup_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Setup Warmup"
}
},
"/stats/usage": {
"get": {
"operationId": "stats_usage_stats_usage_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Stats Usage"
}
},
"/stories/encode": {
"post": {
"description": "Transcode an uploaded WAV to MP3/M4B/OGG and return the encoded bytes.\n\nProvenance note (#1169): this endpoint is a pure TRANSCODER, not a\nsynthesis producer \u2014 it never calls a TTS engine, so it must not call\nmark_synthetic (the upload may be arbitrary user audio, and marking human\nspeech as synthetic would be wrong). Audio the Stories Editor stitched\nfrom VoiceStudio generations is already marked at its producing route, and\nthe AudioSeal mark survives the lossy encode here.",
"operationId": "stories_encode_stories_encode_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_stories_encode_stories_encode_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Stories Encode"
}
},
"/sysinfo": {
"get": {
"operationId": "get_sys_info_sysinfo_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SysinfoResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "Get Sys Info"
}
},
"/system/asr-backends": {
"get": {
"description": "List all registered ASR backends and their availability.",
"operationId": "asr_backends_system_asr_backends_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Asr Backends"
}
},
"/system/crash/ack": {
"post": {
"description": "Mark the current crash log as seen \u2014 dismisses the\n'crash-last-session' notification until the log changes again.",
"operationId": "ack_crash_system_crash_ack_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Ack Crash"
}
},
"/system/diagnose": {
"get": {
"description": "Run the self-check suite (core.diagnose) and return the structured report.\n\nThe hub probe can block up to ~5s (and ``deep=true`` far longer), so the\nwhole run goes through a threadpool; pass ``network=false`` for an\ninstant offline report. Output is pre-scrubbed (core.scrub) \u2014 safe to\npaste into a GitHub issue.",
"operationId": "system_diagnose_system_diagnose_get",
"parameters": [
{
"description": "Include the HuggingFace hub reachability probe",
"in": "query",
"name": "network",
"required": false,
"schema": {
"default": true,
"description": "Include the HuggingFace hub reachability probe",
"title": "Network",
"type": "boolean"
}
},
{
"description": "Also load the active engine and synthesize a short utterance (may cold-load the model \u2014 minutes on first run)",
"in": "query",
"name": "deep",
"required": false,
"schema": {
"default": false,
"description": "Also load the active engine and synthesize a short utterance (may cold-load the model \u2014 minutes on first run)",
"title": "Deep",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "System Diagnose"
}
},
"/system/diagnostic-bundle": {
"post": {
"description": "Build the drag-onto-a-GitHub-issue zip (core.diagnostic_bundle):\nself-check report, recent error journal, scrubbed log tails. Returns the\nlocal path so the UI can reveal it in the file manager. The path itself\nis NOT scrubbed \u2014 this response never leaves the machine; the zip's\n*contents* are scrubbed because the zip does.",
"operationId": "diagnostic_bundle_system_diagnostic_bundle_post",
"parameters": [
{
"description": "Include the hub reachability probe",
"in": "query",
"name": "network",
"required": false,
"schema": {
"default": false,
"description": "Include the hub reachability probe",
"title": "Network",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Diagnostic Bundle"
}
},
"/system/errors/recent": {
"get": {
"description": "Recent unhandled backend errors, newest first \u2014 structured, deduped\n(count per fingerprint), classified (error_class), pre-scrubbed. The\nbug-report pipeline reads this to auto-attach the most recent backend\nfailure; Settings \u2192 Logs can render it as a triage view.",
"operationId": "recent_errors_system_errors_recent_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 20,
"maximum": 50,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Recent Errors"
}
},
"/system/flush-memory": {
"post": {
"description": "Aggressively release RAM/VRAM by clearing caches and running GC.\n\nWhen unload_model=true, the TTS model is fully unloaded and will be\nre-loaded lazily on the next generation request.",
"operationId": "flush_memory_system_flush_memory_post",
"parameters": [
{
"in": "query",
"name": "unload_model",
"required": false,
"schema": {
"default": false,
"title": "Unload Model",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Flush Memory"
}
},
"/system/hf-token/state": {
"get": {
"description": "Return the 3-source HF token cascade state for the Settings UI\n(Wave 2 React panel consumes this). Never returns the raw token \u2014\nonly a masked preview and local presence; no outbound validation.",
"operationId": "hf_token_state_system_hf_token_state_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Hf Token State"
}
},
"/system/info": {
"get": {
"description": "Settings page system info \u2014 model, tokens, data dir, timeout.\n\nThis endpoint MUST never throw \u2014 it's called on every Settings page load\nand a 500 here blocks the entire UI from rendering system details.",
"operationId": "system_info_system_info_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemInfoResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "System Info"
}
},
"/system/last-run-crash": {
"get": {
"description": "Newest unclean-shutdown record from the previous backend run (#1164)\n\u2014 the deployment-agnostic twin of the desktop shell's crash marker\n(`get_last_backend_crash`), for browser/dev/Docker frontends that have no\nshell to ask. Version-gated like the shell's markers: records from a\ndifferent release than the running build are ignored (kept on disk).",
"operationId": "get_last_run_crash_system_last_run_crash_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Last Run Crash"
}
},
"/system/last-run-crash/ack": {
"post": {
"description": "Mark the newest unclean-shutdown record as seen. Watermark semantics\n(like the shell's ack): the record itself is retained so bug reports can\nstill attach the evidence; a NEWER death re-arms the notice.",
"operationId": "ack_last_run_crash_system_last_run_crash_ack_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Ack Last Run Crash"
}
},
"/system/logs": {
"get": {
"description": "Tail the rolling runtime log \u2014 everything Python logged since last rotation.\n\nBack-stop: if the rolling log doesn't exist yet (fresh install, disk error),\nfall back to the crash log so the UI always has something to show.",
"operationId": "system_logs_system_logs_get",
"parameters": [
{
"in": "query",
"name": "tail",
"required": false,
"schema": {
"default": 200,
"title": "Tail",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "System Logs"
}
},
"/system/logs/clear": {
"post": {
"description": "Truncate the rolling runtime log and the crash log (what the Backend tab reads).\n\nIncludes the rotated siblings. Truncating only omnivoice.log left up to\n6 MB in .1/.2/.3, so Clear freed almost nothing and \u2014 now that the tail\nreaches into those files \u2014 would have looked like it did nothing at all.",
"operationId": "clear_system_logs_system_logs_clear_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Clear System Logs"
}
},
"/system/logs/stream": {
"get": {
"description": "Server-Sent Events stream of new log lines.\n\nThe client opens an EventSource connection and receives new lines as they\nare appended to the log file. This replaces the polling pattern used by\nthe LogsFooter component.\n\nUsage (frontend)::\n\n const es = new EventSource('/system/logs/stream?source=backend');\n es.onmessage = (e) => { const lines = JSON.parse(e.data); ... };",
"operationId": "stream_logs_system_logs_stream_get",
"parameters": [
{
"description": "'backend' or 'tauri'",
"in": "query",
"name": "source",
"required": false,
"schema": {
"default": "backend",
"description": "'backend' or 'tauri'",
"title": "Source",
"type": "string"
}
},
{
"description": "Poll interval in seconds",
"in": "query",
"name": "interval",
"required": false,
"schema": {
"default": 1.0,
"description": "Poll interval in seconds",
"maximum": 10.0,
"minimum": 0.3,
"title": "Interval",
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Stream Logs"
}
},
"/system/logs/tauri": {
"get": {
"description": "Tail the Tauri plugin log (or backend stdout redirect, whichever exists).",
"operationId": "system_logs_tauri_system_logs_tauri_get",
"parameters": [
{
"in": "query",
"name": "tail",
"required": false,
"schema": {
"default": 200,
"title": "Tail",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "System Logs Tauri"
}
},
"/system/logs/tauri/clear": {
"post": {
"description": "Truncate the shell's own log files. OS-level rotation may recreate them.\n\nThe backend stdout/stderr redirect is deliberately excluded. This button\nlives on a tab that shows `tauri.log`, and truncating `backend_err.log`\nfrom it destroyed evidence the user was never shown \u2014 the one record of a\nnative death, which writes nothing to the Python log. `backend.rs`'s\n`open_err_log_for_run()` opens that file append-only precisely so \"a\nrespawn must not destroy the previous run's evidence\" (#1510) and rotates\nit to `.1` instead of truncating, so it manages its own size and does not\nneed clearing from here.",
"operationId": "clear_tauri_logs_system_logs_tauri_clear_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Clear Tauri Logs"
}
},
"/system/network/disable": {
"post": {
"operationId": "network_disable_system_network_disable_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Network Disable"
}
},
"/system/network/enable": {
"post": {
"operationId": "network_enable_system_network_enable_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Network Enable"
}
},
"/system/network/state": {
"get": {
"operationId": "network_state_system_network_state_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Network State"
}
},
"/system/notifications": {
"get": {
"description": "Return actionable notifications for the UI notification panel.\n\nEach notification has:\n - id: unique key (for dismiss tracking)\n - level: \"info\" | \"warn\" | \"error\"\n - title: short heading\n - message: longer description\n - action: optional {\"label\": str, \"type\": \"navigate|link|api\", \"target\": str}",
"operationId": "system_notifications_system_notifications_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "System Notifications"
}
},
"/system/quarantine-status": {
"get": {
"description": "Report whether the running .app bundle has the macOS quarantine xattr.\n\nOn non-macOS platforms or dev runs (not inside a .app bundle), always\nreturns ``{\"quarantined\": false, \"error_class\": null}``. The React\nErrorBoundary polls this endpoint on first load and renders the docs\ndeeplink when ``error_class`` is set (Plan 01-02 wired the deeplink).",
"operationId": "quarantine_status_system_quarantine_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Quarantine Status"
}
},
"/system/set-env": {
"post": {
"description": "Set an environment variable at runtime, persisted across restarts.\n\nPersistent keys (proxy, FFMPEG_PATH, translation provider keys, \u2026) are\nsaved to ``prefs.json`` so they survive backend restarts (restored at\nstartup in ``main.py``). HF_TOKEN is persisted via\n``token_resolver.persist_hub_token()`` (and cleared with the shared token-file helper). Other keys\nare set on ``os.environ`` for the running process.\n\nThe loopback-origin gate that previously lived inline here is now applied\nat the router level via `dependencies=[Depends(require_admin)]` on\n`router` \u2014 see the top of this file. Every route on this router is\ngated, including this one. The 403 body and behavior are unchanged.",
"operationId": "set_env_var_system_set_env_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Body",
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Env Var"
}
},
"/system/tailscale/disable": {
"post": {
"operationId": "tailscale_disable_system_tailscale_disable_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Tailscale Disable"
}
},
"/system/tailscale/enable": {
"post": {
"operationId": "tailscale_enable_system_tailscale_enable_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Tailscale Enable"
}
},
"/system/tailscale/status": {
"get": {
"operationId": "tailscale_status_system_tailscale_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Tailscale Status"
}
},
"/tasks/cancel/{task_id}": {
"post": {
"description": "Cancel a running background task (e.g. dub generation).",
"operationId": "cancel_task_tasks_cancel__task_id__post",
"parameters": [
{
"in": "path",
"name": "task_id",
"required": true,
"schema": {
"title": "Task Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Task"
}
},
"/tasks/stream/{task_id}": {
"get": {
"description": "Universal Server-Sent Event stream for background tasks.\n\n`?after_seq=N` enables resumption: on reconnect, the client replays\npersisted events with seq > N, then (if the job is still live) attaches\nto the in-memory listener for live updates. After a server restart the\nin-memory task is gone but the persisted tail + final `jobs.status` are\nstill readable, so a mid-stream reload still sees the final state.",
"operationId": "stream_task_tasks_stream__task_id__get",
"parameters": [
{
"in": "path",
"name": "task_id",
"required": true,
"schema": {
"title": "Task Id",
"type": "string"
}
},
{
"in": "query",
"name": "after_seq",
"required": false,
"schema": {
"default": 0,
"title": "After Seq",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Stream Task"
}
},
"/tools/direction": {
"post": {
"operationId": "parse_direction_tools_direction_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectionReq"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Parse Direction"
}
},
"/tools/effects": {
"get": {
"description": "Return available audio effect presets (Broadcast, Cinematic, etc.).",
"operationId": "list_effects_tools_effects_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Effects"
}
},
"/tools/incremental": {
"post": {
"operationId": "plan_incremental_tools_incremental_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncrementalReq"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Plan Incremental"
}
},
"/tools/normalize-speech": {
"post": {
"description": "Peak-normalize synthetic speech; bounded and entirely local.",
"operationId": "normalize_workflow_speech_tools_normalize_speech_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_normalize_workflow_speech_tools_normalize_speech_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Normalize Workflow Speech"
}
},
"/tools/plugins": {
"get": {
"description": "Return all registered TTS engine plugins and their availability.",
"operationId": "list_tts_plugins_tools_plugins_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Tts Plugins"
}
},
"/tools/probe": {
"post": {
"operationId": "probe_tools_probe_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProbeReq"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Probe"
}
},
"/tools/rate-fit": {
"post": {
"operationId": "rate_fit_tools_rate_fit_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RateFitReq"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Rate Fit"
}
},
"/tools/video-context/{job_id}": {
"post": {
"description": "Analyse the source video's visual context for dubbing decisions.\n\nReturns per-segment mood, brightness, and complexity cues that\ncan be used as TTS instruct hints.",
"operationId": "analyse_video_context_tools_video_context__job_id__post",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Analyse Video Context"
}
},
"/transcribe": {
"post": {
"description": "Transcribe an audio file to text.\n\nArgs:\n audio: The audio file to transcribe.\n language: Optional language hint (not currently used; auto-detected).\n model: Whisper model size (legacy; ignored in dual-mode architecture).\n mode: 'fast' (default) uses MLX Turbo for speed; 'accurate' uses\n the selected ASR engine with word-level timing. 'reference' uses\n the selected ASR engine without word-level timing.\n refine: Opt-in local-LLM cleanup of the final text (disfluencies,\n self-corrections, punctuation) \u2014 same pipeline the live\n dictation socket uses. Off by default so MCP/CLI callers don't\n pay LLM latency unless they ask; honours the user's\n Settings \u2192 Dictation-refinement config and silently passes\n through when no LLM backend is configured. The raw ``text``\n is always returned; ``refined_text`` is added only when the\n LLM actually changed something.\n dictation: Opt-in flag for hotkey-dictation callers: applies the\n saved dictation vocabulary hint (``dictation.prompt``) to\n engines that accept a prompt. Off by default so file\n transcription and MCP/CLI callers are never biased by it;\n ignored in 'reference' mode.\n\nReturns:\n {\n \"text\": \"full transcription\",\n \"refined_text\": \"cleaned text\", # only when refine=true changed it\n \"segments\": [ {\"start\": 0.0, \"end\": 1.5, \"text\": \"...\"}, ... ],\n \"language\": \"en\",\n \"duration_s\": 4.2,\n \"transcription_time_s\": 0.8,\n \"engine\": \"mlx-whisper\"\n }",
"operationId": "transcribe_audio_transcribe_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_transcribe_audio_transcribe_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Transcribe Audio"
}
},
"/v1/audio/capabilities": {
"get": {
"description": "Advertise batch, streaming, and agent-facing speech transports.",
"operationId": "get_speech_capabilities_v1_audio_capabilities_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpeechCapabilities"
}
}
},
"description": "Successful Response"
}
},
"summary": "Get Speech Capabilities",
"tags": [
"Speech Platform"
]
}
},
"/v1/audio/speech": {
"post": {
"description": "Generate audio from text. Compatible with OpenAI's POST /v1/audio/speech.",
"operationId": "create_speech_v1_audio_speech_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpeechRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Speech",
"tags": [
"OpenAI-Compatible Audio API"
]
}
},
"/v1/audio/transcriptions": {
"post": {
"description": "Transcribe audio to text. Compatible with OpenAI's POST /v1/audio/transcriptions.",
"operationId": "create_transcription_v1_audio_transcriptions_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_transcription_v1_audio_transcriptions_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Transcription",
"tags": [
"OpenAI-Compatible Audio API"
]
}
},
"/v1/audio/translations": {
"post": {
"description": "Translate speech into English text. Compatible with OpenAI's\nPOST /v1/audio/translations; needs a Whisper-family ASR engine.",
"operationId": "create_translation_v1_audio_translations_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_translation_v1_audio_translations_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Translation",
"tags": [
"OpenAI-Compatible Audio API"
]
}
},
"/v1/audio/voices": {
"get": {
"description": "List available voices. VoiceStudio extension to the OpenAI API.",
"operationId": "list_voices_v1_audio_voices_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Voices",
"tags": [
"OpenAI-Compatible Audio API"
]
}
},
"/v1/models": {
"get": {
"description": "OpenAI-shaped model list: OpenAI aliases plus every installed engine.",
"operationId": "list_models_v1_models_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "List Models",
"tags": [
"OpenAI-Compatible Audio API"
]
}
},
"/v1/models/{model_id}": {
"get": {
"description": "One model from GET /v1/models (OpenAI's retrieve shape).",
"operationId": "retrieve_model_v1_models__model_id__get",
"parameters": [
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"title": "Model Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Retrieve Model",
"tags": [
"OpenAI-Compatible Audio API"
]
}
},
"/watermark/detect": {
"post": {
"description": "Upload an audio file and check whether it contains a VoiceStudio watermark.\n\nReturns confidence score, decoded message, and source attribution.",
"operationId": "detect_audio_watermark_watermark_detect_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_detect_audio_watermark_watermark_detect_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Detect Audio Watermark"
}
},
"/watermark/settings": {
"post": {
"description": "Update watermark preferences.",
"operationId": "update_watermark_settings_watermark_settings_post",
"parameters": [
{
"in": "query",
"name": "invisible",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Invisible"
}
},
{
"in": "query",
"name": "visible_audio",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Visible Audio"
}
},
{
"in": "query",
"name": "visible_video",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Visible Video"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Watermark Settings"
}
},
"/watermark/status": {
"get": {
"description": "Return current watermark configuration.",
"operationId": "watermark_status_watermark_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Watermark Status"
}
}
}
}