Sequence Monkey

https://openapi.mobvoi.com/
Admin
Sequence Monkey is a multimodal AI platform by Mobvoi offering speech recognition, text generation,...
Tokens:12,591
Snippets:155
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### POST /api/tts/v1

Source: https://openapi.mobvoi.com/document?name=%E8%AF%AD%E9%9F%B3%E5%90%88%E6%88%90%EF%BC%88TTS%EF%BC%89

Synthesizes speech from provided text using various customizable options.

```APIDOC
## POST /api/tts/v1

### Description
Synthesizes speech from provided text. Supports SSML for advanced text formatting and offers numerous parameters for voice customization, audio format, and streaming options.

### Method
POST

### Endpoint
https://open.mobvoi.com/api/tts/v1

### Parameters
#### Header Parameters
- **Content-Type** (String) - Required - Specifies the structure of the request body. Example: application/json

#### Request Body
- **text** (String) - Required - The content to be synthesized. Max 1000 characters. Supports SSML.
- **appkey** (String) - Required - Your developer key obtained from the AI Open Platform.
- **signature** (String) - Required - MD5 hash of "appkey+secret+timestamp". Valid for 10 minutes.
- **timestamp** (Long) - Required - Current timestamp in seconds.
- **speaker** (String) - Optional - Desired voice. Default: cissy_meet. See sound store for other options.
- **audio_type** (String) - Optional - Format of the synthesized audio. Default: mp3. Options: pcm, mp3, speex-wb-10, wav.
- **speed** (Float) - Optional - Speech speed. Default: 1.0. Range: 0.5-2.0.
- **convert** (String) - Optional - Converts speech to robot voice. Option: robot.
- **rate** (Long) - Optional - Audio sample rate. Default: determined by speaker. Options: 8000, 16000, 24000.
- **volume** (Float) - Optional - Synthesis volume. Default: 1.0. Range: 0.1-1.0.
- **pitch** (Float) - Optional - Pitch adjustment. Default: 0. Range: -10 to 10.
- **pause_map** (String) - Optional - Enables a compact listening experience by reducing pauses. Options: open, close. Only effective for 'meet' and 'mercury' speakers.
- **symbol_sil** (String) - Optional - Symbol pause duration mapping. Example: symbol_sil=semi_200,exclamation_200.
- **ignore_limit** (Boolean) - Optional - Ignores character limits. Default: false. Options: true (max 3000 chars), false.
- **gen_srt** (Boolean) - Optional - Generates SRT subtitle file. Default: false. Requires ignore_limit=true and audio_type=wav.
- **merge_symbol** (Boolean) - Optional - Coarse-grained synthesis parameter. Default: false. Options: true, false. If true, symbol_sil is ignored.
- **srt_len** (Long) - Optional - Maximum length for generated subtitles. Sentences are split at punctuation.
- **streaming** (Boolean) - Optional - Enables streaming output. Default: false. Options: true, false. Requires ignore_limit=true and audio_type not wav.

### Request Example
```json
{
  "text": "你好，欢迎使用百度语音合成",
  "appkey": "YOUR_APP_KEY",
  "signature": "YOUR_SIGNATURE",
  "timestamp": 1678886400,
  "speaker": "cissy_meet",
  "audio_type": "mp3",
  "speed": 1.0,
  "volume": 1.0,
  "pitch": 0
}
```

### Response
#### Success Response (200)
- **Content-Type** (String) - Specifies the structure of the response body. Example: audio/mpeg
- **srt_address** (String) - Optional - URL to the generated SRT subtitle file if `gen_srt` is true.

If successful, the API returns the audio stream directly. For streaming requests, the audio is returned in chunks.

#### Response Example (Audio Stream)
(Binary audio data)

#### Error Response Body
- **status** (String) - Indicates failure. Example: error
- **errorMessage** (Object) - Contains details about the error.
  - **code** (Int) - Error code. Example: 31002
  - **desc** (String) - Description of the error. Example: failed to convert text to speech

### Error Response Example
```json
{
  "status": "error",
  "errorMessage": {
    "code": 31002,
    "desc": "failed to convert text to speech"
  }
}
```

### Symbol Pause Mapping Table
- **Symbol**: ; | **Setting**: semi_200 (200ms pause)
- **Symbol**: ! | **Setting**: exclamation_200 (200ms pause)
- **Symbol**: ? | **Setting**: question_200 (200ms pause)
- **Symbol**: , | **Setting**: comma_200 (200ms pause)
- **Symbol**: 。 | **Setting**: stop_200 (200ms pause)
- **Symbol**: 、 | **Setting**: pause_200 (200ms pause)

```
Tokens:
Raw