Update README.md
Browse files
README.md
CHANGED
|
@@ -7,10 +7,16 @@ This document explains how to call the **`generate_squirrel`** endpoint.
|
|
| 7 |
|
| 8 |
## 2. Endpoint Summary
|
| 9 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
- **Method:** `POST`
|
| 11 |
- **URL:** `https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel`
|
| 12 |
-
- **Headers:**
|
| 13 |
-
- `Content-Type: application/json`
|
| 14 |
- **Request Body**
|
| 15 |
```json
|
| 16 |
{
|
|
@@ -22,28 +28,20 @@ This document explains how to call the **`generate_squirrel`** endpoint.
|
|
| 22 |
|
| 23 |
| Field | Type | Required | Description |
|
| 24 |
|-----------|--------|----------|-----------------------------------------------------------------------------|
|
| 25 |
-
| `text` | string | Yes | Text you want to synthesize.
|
| 26 |
-
| `voice_id`| string | Yes | UUID of the voice to use. Must match one of the IDs in the voices
|
| 27 |
|
| 28 |
|
| 29 |
## 3. Example Requests
|
| 30 |
|
| 31 |
-
|
| 32 |
-
```bash
|
| 33 |
-
curl --location 'https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel' --header 'Content-Type: application/json' --data '{
|
| 34 |
-
"text": "hi i thought i am the best",
|
| 35 |
-
"voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba"
|
| 36 |
-
}'
|
| 37 |
-
```
|
| 38 |
-
|
| 39 |
-
- **4.2 Python using `requests`**
|
| 40 |
```python
|
| 41 |
import requests
|
| 42 |
|
| 43 |
url = "https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel"
|
| 44 |
|
| 45 |
payload = {
|
| 46 |
-
"text": "
|
| 47 |
"voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba",
|
| 48 |
}
|
| 49 |
|
|
@@ -55,7 +53,7 @@ This document explains how to call the **`generate_squirrel`** endpoint.
|
|
| 55 |
|
| 56 |
```
|
| 57 |
|
| 58 |
-
##
|
| 59 |
|
| 60 |
| id | name | audio_gender | languages |
|
| 61 |
|:-------------------------------------|:-----------------------|:---------------|:------------|
|
|
|
|
| 7 |
|
| 8 |
## 2. Endpoint Summary
|
| 9 |
|
| 10 |
+
- **cURL (basic example)**
|
| 11 |
+
```bash
|
| 12 |
+
curl --location 'https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel' --header 'Content-Type: application/json' --data '{
|
| 13 |
+
"text": "Hello दोस्तों! Welcome to Ringg TTS. यह एक बहुत ही शानदार text to speech system है जो Hindi और English दोनों languages को support करता है।",
|
| 14 |
+
"voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba"
|
| 15 |
+
}'
|
| 16 |
+
```
|
| 17 |
- **Method:** `POST`
|
| 18 |
- **URL:** `https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel`
|
| 19 |
+
- **Headers:** `Content-Type: application/json`
|
|
|
|
| 20 |
- **Request Body**
|
| 21 |
```json
|
| 22 |
{
|
|
|
|
| 28 |
|
| 29 |
| Field | Type | Required | Description |
|
| 30 |
|-----------|--------|----------|-----------------------------------------------------------------------------|
|
| 31 |
+
| `text` | string | Yes | Text you want to synthesize. Limited to **300** characters. |
|
| 32 |
+
| `voice_id`| string | Yes | **UUID** of the voice to use. Must match one of the IDs in the voices provided below. |
|
| 33 |
|
| 34 |
|
| 35 |
## 3. Example Requests
|
| 36 |
|
| 37 |
+
**Python using `requests`**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 38 |
```python
|
| 39 |
import requests
|
| 40 |
|
| 41 |
url = "https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel"
|
| 42 |
|
| 43 |
payload = {
|
| 44 |
+
"text": "Hello दोस्तों! Welcome to Ringg TTS. यह एक बहुत ही शानदार text to speech system है जो Hindi और English दोनों languages को support करता है।",
|
| 45 |
"voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba",
|
| 46 |
}
|
| 47 |
|
|
|
|
| 53 |
|
| 54 |
```
|
| 55 |
|
| 56 |
+
## 4. Voices Catalogue (CSV)
|
| 57 |
|
| 58 |
| id | name | audio_gender | languages |
|
| 59 |
|:-------------------------------------|:-----------------------|:---------------|:------------|
|