Voice Design

Describe a voice style in natural language and generate speech from text in the corresponding style.

Workflow

1. Create an API Key

   Open the API Key management platform, create an API Key, and save it as an environment variable. Do not write the API Key into client-side code or commit it to a repository.

   export MOSS_API_KEY="<your-api-key>"
   

2. Prepare the request input

   Use model to specify the model, use instruction to describe the target voice style in natural language, and put the text to synthesize into input.

   input: text to generate speech from instruction: voice style description delivery_method: audio or url

   {
     "model": "moss-voice-generator",
     "input": "Welcome to tonight's show.",
     "instruction": "A gentle, natural young female voice with a hint of a smile",
     "delivery_method": "url",
     "response_format": "mp3"
   }
   

3. Send the first request

   Send a request to POST /v1/audio/voice/generations. When delivery_method=url, JSON and a result URL are returned synchronously.

   cURLPythonTypeScript

   curl https://api.mosi.cn/v1/audio/voice/generations \
     -H "Authorization: Bearer $MOSS_API_KEY" \
     -H "Content-Type: application/json" \
     -d @request.json
   

   import json
   import os
   import requests
   
   payload = json.load(open("request.json"))
   resp = requests.post(
       "https://api.mosi.cn/v1/audio/voice/generations",
       headers={"Authorization": f"Bearer {os.environ['MOSS_API_KEY']}"},
       json=payload,
   )
   print(resp.json())
   

   const resp = await fetch('https://api.mosi.cn/v1/audio/voice/generations', {
     method: 'POST',
     headers: {
       Authorization: `Bearer ${apiKey}`,
       'Content-Type': 'application/json',
     },
     body: JSON.stringify(payload),
   })
   

4. Retrieve the result

   When delivery_method=url, read the result URL from the JSON of the synchronous response. If you pass async=true, the endpoint first returns a task_id, which you then use to query the task.

   curl https://api.mosi.cn/v1/audio/tasks/$TASK_ID \
     -H "Authorization: Bearer $MOSS_API_KEY"
   

5. Verify success

   Success indicator: you obtain audio generated in the described style or a result URL, and can download or play it.

Next steps