{"servers":[{"url":"https://api.modellix.ai/api/v1/alibaba/cosyvoice-design"}],"post":{"description":"[Core Function] CosyVoice Design creates a temporary voice from a natural-language voice_prompt and synthesizes speech in one async request; only the final audio is returned. [Strengths] No voice enrollment management; language_hint (zh/en) applies to both design and synthesis; same prosody and format controls as CosyVoice TTS. [Best For] One-off designed speech without storing enrolled voices. [Limitations] Do NOT use this to obtain a reusable voice library entry; the designed voice is temporary and is not returned. model must be cosyvoice-v3.5-plus or cosyvoice-v3.5-flash; voice_prompt and text are required.","operationId":"cosyvoiceDesign","requestBody":{"content":{"application/json":{"example":{"format":"mp3","language_hint":"en","model":"cosyvoice-v3.5-plus","text":"Hello, welcome to Modellix. Today we will introduce our products.","voice_prompt":"Calm male announcer with a deep tone"},"schema":{"description":"One-shot voice design + TTS. Required: model, voice_prompt, text. The designed voice is temporary and is not returned.","properties":{"bit_rate":{"description":"Audio bit rate in kbps. Optional. Range 6–510. Only supported when format is opus.","example":32,"maximum":510,"minimum":6,"type":"integer"},"enable_ssml":{"default":false,"description":"Whether to parse text as SSML. Default false.","example":false,"type":"boolean"},"format":{"default":"mp3","description":"Output audio encoding format. Default mp3.","enum":["mp3","pcm","wav","opus"],"example":"mp3","type":"string"},"hot_fix":{"description":"Text hot-fix before synthesis. Same as CosyVoice TTS hot_fix.","example":{"replace":[{"Modellix":"Modelix"}]},"type":"object"},"instruction":{"description":"Optional speaking-style instruction. Weighted length ≤100 (CJK ideographs count as 2).","example":"Speak in a friendly customer-service tone.","type":"string"},"language_hint":{"default":"zh","description":"Language hint for both design and synthesis (zh/en only). Default zh.","enum":["zh","en"],"example":"en","type":"string"},"model":{"description":"Target CosyVoice v3.5 TTS model used for synthesis after voice design.","enum":["cosyvoice-v3.5-plus","cosyvoice-v3.5-flash"],"type":"string"},"pitch":{"default":1,"description":"Pitch multiplier. Default 1.0. Range 0.5–2.0.","example":1,"maximum":2,"minimum":0.5,"type":"number"},"rate":{"default":1,"description":"Speech rate multiplier. Default 1.0. Range 0.5–2.0.","example":1,"maximum":2,"minimum":0.5,"type":"number"},"sample_rate":{"default":22050,"description":"Output sample rate in Hz. Default 22050.","enum":[8000,16000,22050,24000,44100,48000],"example":24000,"type":"integer"},"seed":{"default":0,"description":"Random seed. Default 0. Range 0–65535.","example":0,"maximum":65535,"minimum":0,"type":"integer"},"text":{"description":"Text to synthesize with the temporarily designed voice. Required. Max 20,000 Unicode characters.","example":"Hello, welcome to Modellix. Today we will introduce our products.","maxLength":20000,"minLength":1,"type":"string"},"voice_prompt":{"description":"Natural-language voice description (Chinese or English). Required. Max 500 Unicode characters.","example":"Calm male announcer with a deep tone","maxLength":500,"minLength":1,"type":"string"},"volume":{"default":50,"description":"Output volume. Default 50. Range 0–100.","example":50,"maximum":100,"minimum":0,"type":"integer"}},"required":["model","voice_prompt","text"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"code":0,"data":{"get_result":{"method":"GET","url":"https://api.modellix.ai/api/v1/tasks/task-cosyvoice-design-001"},"model_id":"alibaba/cosyvoice-design","status":"pending","task_id":"task-cosyvoice-design-001"},"message":"success"},"schema":{"description":"Response object for asynchronous task submission.","properties":{"code":{"description":"Response code, 0 indicates success","example":0,"type":"integer"},"data":{"description":"Task submission details. Poll GET /api/v1/tasks/{task_id} until status is success; audio appears in result.resources.","properties":{"get_result":{"description":"Endpoint to query the task result. See Common API: Query Task Result.","properties":{"method":{"example":"GET","type":"string"},"url":{"example":"https://api.modellix.ai/api/v1/tasks/task-cosyvoice-v3-plus-001","type":"string"}},"type":"object"},"model_id":{"description":"Model ID in provider/model format","example":"alibaba/cosyvoice-v3-plus","type":"string"},"status":{"description":"Initial task status","enum":["pending","processing"],"example":"pending","type":"string"},"task_id":{"description":"Unique task identifier for polling","example":"task-cosyvoice-v3-plus-001","type":"string"}},"required":["status","task_id","model_id"],"type":"object"},"message":{"description":"Response message","example":"success","type":"string"}},"required":["code","message","data"],"type":"object"}}},"description":"Task submitted successfully. Poll GET /api/v1/tasks/{task_id} until the task completes; synthesized audio is returned on the task result."},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid parameters: voice is required for alibaba/cosyvoice-v3-plus"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: voice is required for alibaba/cosyvoice-v3-plus","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"example":{"code":401,"message":"Authentication failed: invalid API key"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: voice is required for alibaba/cosyvoice-v3-plus","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Unauthorized - Invalid or missing API Key"},"429":{"content":{"application/json":{"example":{"code":429,"message":"Rate limit exceeded: 100 requests per minute, retry after 60 seconds"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: voice is required for alibaba/cosyvoice-v3-plus","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Too many requests - Rate limit exceeded","headers":{"X-RateLimit-Limit":{"description":"Maximum requests per minute","schema":{"example":100,"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining quota in current window","schema":{"example":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"Rate limit window reset time (Unix timestamp)","schema":{"example":1704067260,"type":"integer"}}}},"500":{"content":{"application/json":{"example":{"code":500,"message":"Internal server error"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: voice is required for alibaba/cosyvoice-v3-plus","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Internal server error"}},"summary":"CosyVoice One-shot Voice Design + TTS","x-mint":{"href":"alibaba/cosyvoice-design"}}}