{"openapi":"3.1.0","info":{"title":"DotVoice TTS API","version":"1.0","description":"Hindi and English text-to-speech. Billed per character from your prepaid wallet. WebSocket streaming: see /developers."},"servers":[{"url":"https://tts.dotvoice.in"}],"paths":{"/api/v1/voices":{"get":{"tags":["voices"],"summary":"List Voices","operationId":"list_voices_api_v1_voices_get","parameters":[{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/voices/{voice_id}":{"get":{"tags":["voices"],"summary":"Get Voice","operationId":"get_voice_api_v1_voices__voice_id__get","parameters":[{"name":"voice_id","in":"path","required":true,"schema":{"type":"string","title":"Voice Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/models":{"get":{"tags":["models"],"summary":"List Models","operationId":"list_models_api_v1_models_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tts/synthesize":{"post":{"tags":["synthesis"],"summary":"Synthesize","description":"Complete audio as raw bytes. Metadata rides in the response headers.\n\nCustomer keys are billed (docs/platform/03): charged before synthesis,\nrefunded if it fails on our side, billing in X-DotVoice-* headers.","operationId":"synthesize_api_v1_tts_synthesize_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynthesizeBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tts/stream":{"post":{"tags":["synthesis"],"summary":"Stream","description":"Chunked stream. First bytes leave as soon as the model produces them.\n\nThis is the endpoint the realtime bots use. The consumer paces playback\nitself (20 ms frames), so we do not pace here - sending as fast as the\nmodel produces is what lets the caller build a small jitter buffer.","operationId":"stream_api_v1_tts_stream_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynthesizeBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/transliterate":{"post":{"tags":["synthesis"],"summary":"Transliterate","description":"What would be spoken, without synthesising: Roman Hindi -> Devanagari.\n\nFree (no audio, no charge). Capped by the per-key request limit like\nevery API call. For previews in the customer's own application.","operationId":"transliterate_api_v1_transliterate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransliterateBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tts/requests/{request_id}/cancel":{"post":{"tags":["synthesis"],"summary":"Cancel","description":"Stop an in-flight synthesis. Used for barge-in.","operationId":"cancel_api_v1_tts_requests__request_id__cancel_post","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","title":"Request Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/stt/transcribe":{"post":{"tags":["speech-to-text"],"summary":"Stt Transcribe","description":"Speech to text. Send the audio as the request body (any common format, or raw ulaw/alaw/pcm_s16le\nwith `format` and `sample_rate`), or as multipart field `file`. language: en | hi | hi-Latn.\nAudio up to 30 s is answered in this response; longer audio (up to 10 min) returns 202 and a job\nid to poll at GET /api/v1/stt/jobs/{id}. Billed per second of audio from the wallet.","operationId":"stt_transcribe_api_v1_stt_transcribe_post","parameters":[{"name":"language","in":"query","required":false,"schema":{"type":"string","default":"en","title":"Language"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"auto","title":"Format"}},{"name":"sample_rate","in":"query","required":false,"schema":{"type":"integer","default":8000,"title":"Sample Rate"}},{"name":"wait","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Wait"}},{"name":"request_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/stt/jobs/{job_id}":{"get":{"tags":["speech-to-text"],"summary":"Stt Job","description":"A transcription job: status, and the transcript when done. format=json | txt | srt.","operationId":"stt_job_api_v1_stt_jobs__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/ws-token":{"post":{"tags":["streaming"],"summary":"Ws Token","description":"A single-use token, valid 60 seconds, for opening the WebSocket from a\nbrowser (which cannot send an Authorization header). Call it from your\nserver, pass the token to the browser, connect with `?token=`.","operationId":"ws_token_api_v1_auth_ws_token_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/account":{"get":{"tags":["account"],"summary":"Account","description":"The calling customer's balance, rate and limits.","operationId":"account_api_v1_account_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/usage":{"get":{"tags":["account"],"summary":"Usage","description":"Characters, requests and cost per day (UTC days), most recent last.","operationId":"usage_api_v1_usage_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","default":30,"title":"Days"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SynthesizeBody":{"properties":{"text":{"type":"string","title":"Text","description":"Text to speak."},"voice_id":{"type":"string","title":"Voice Id"},"language":{"type":"string","title":"Language","default":"hi-Latn"},"output_format":{"type":"string","title":"Output Format","default":"pcm_s16le"},"sample_rate":{"type":"integer","title":"Sample Rate","default":8000},"speed":{"type":"number","title":"Speed","default":1.0},"pronunciation_profile":{"type":"string","title":"Pronunciation Profile","default":"india_default"},"priority":{"type":"string","title":"Priority","default":"realtime"},"cacheable":{"type":"boolean","title":"Cacheable","default":true},"normalize":{"type":"boolean","title":"Normalize","default":true},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"type":"object","required":["text","voice_id"],"title":"SynthesizeBody"},"TransliterateBody":{"properties":{"text":{"type":"string","title":"Text","description":"Roman Hindi (Hinglish) text."},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id","description":"Convert as this voice would; default: a Hindi voice."},"language":{"type":"string","title":"Language","default":"hi-Latn"},"pronunciation_profile":{"type":"string","title":"Pronunciation Profile","default":"india_default"}},"type":"object","required":["text"],"title":"TransliterateBody"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your dv_live_ API key"}}},"security":[{"bearer":[]}]}