Hugging Face's logo

RinggAI
/
Ringg-Squirrel-Free-API

Model card Files
xet
Community
utkarshshukla2912 commited on
Commit
6fdbdf3
·
verified ·
1 Parent(s): 058be19

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +114 -0
README.md ADDED
@@ -0,0 +1,114 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ringg Squirrel TTS v1.0 API 🐿️
2
+
3
+ ## 1. Overview
4
+
5
+ Squirrel TTS is Desivocal’s low‑latency text‑to‑speech (TTS) engine.
6
+ This document explains how to call the **`generate_squirrel`** endpoint.
7
+
8
+ ---
9
+
10
+ ## 2. Endpoint Summary
11
+
12
+ - **Method:** `POST`
13
+ - **URL:** `https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel`
14
+ - **Headers:**
15
+ - `Content-Type: application/json`
16
+ - **Request Body**
17
+ ```json
18
+ {
19
+ "text": "Hello दोस्तों! Welcome to Ringg TTS. यह एक बहुत ही शानदार text to speech system है जो Hindi और English दोनों languages को support करता है।",
20
+ "voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba"
21
+ }
22
+ ```
23
+ - **Field details**
24
+
25
+ | Field | Type | Required | Description |
26
+ |-----------|--------|----------|-----------------------------------------------------------------------------|
27
+ | `text` | string | Yes | Text you want to synthesize. Use UTF‑8. Newlines are allowed. |
28
+ | `voice_id`| string | Yes | UUID of the voice to use. Must match one of the IDs in the voices CSV. |
29
+
30
+
31
+
32
+ ---
33
+
34
+ ## 3. Example Requests
35
+
36
+ - **4.1 cURL (basic example)**
37
+ ```bash
38
+ curl --location 'https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel' --header 'Content-Type: application/json' --data '{
39
+ "text": "hi i thought i am the best",
40
+ "voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba"
41
+ }'
42
+ ```
43
+
44
+ - **4.2 Python using `requests`**
45
+ ```python
46
+ import requests
47
+
48
+ url = "https://prod-api2.desivocal.com/dv/api/v0/tts_api/generate_squirrel"
49
+
50
+ payload = {
51
+ "text": "hi i thought i am the best",
52
+ "voice_id": "b4c093ee-05ad-43cc-9e6d-0bdaadc857ba",
53
+ }
54
+
55
+ headers = {
56
+ "Content-Type": "application/json"
57
+ }
58
+
59
+ response = requests.post(url, json=payload, headers=headers)
60
+
61
+ ```
62
+
63
+ ---
64
+
65
+ ## 5. Voices Catalogue (CSV)
66
+
67
+ | id | name | audio_gender | languages |
68
+ |:-------------------------------------|:-----------------------|:---------------|:------------|
69
+ | 153a9408-2959-11ef-b685-a218303b6499 | Youtube Shorts | Male | {hi-IN} |
70
+ | 83ba74e4-9efb-4db3-913a-f2a0ad66904d | Standard | Male | {hi-IN} |
71
+ | 34e961be-4049-4068-b382-6f31792e27b5 | Yuvak | Male | {hi-IN} |
72
+ | 6e9ebcc0-7c1e-4261-9362-9b66bf819eaf | Bigg Boss Lite | Male | {hi-IN} |
73
+ | 25548131-6fcd-4aa1-9112-0601ea9cde9e | Sales Impact Lite | Male | {hi-IN} |
74
+ | e2ba7271-54d1-4414-ac9b-a1300948ef12 | Facebook Ads | Male | {hi-IN} |
75
+ | cfccf6f0-f92e-4793-ba89-7d19c385a4a6 | Aryan | Male | {hi-IN} |
76
+ | 265106e6-c049-487d-ae6a-400dd30caa44 | Dialogue Delivery Lite | Male | {hi-IN} |
77
+ | 9c8ab827-6b6e-45ae-936c-f41ede490ead | Sales | Male | {hi-IN} |
78
+ | f27d74e5-ea71-4697-be3e-f04bbd80c1a8 | Marketing | Male | {hi-IN} |
79
+ | 0cc72d86-2959-11ef-b685-a218303b6499 | Documentary | Male | {hi-IN} |
80
+ | f671e3c0-c9e2-4b7d-992e-3a8a7d7b7789 | Swapnil | Male | {hi-IN} |
81
+ | e775dbe9-db42-4813-85f7-ec3d5f9934b4 | Rohit Bollywood | Male | {hi-IN} |
82
+ | fd5ff2d1-baab-4277-aa0b-fcc75fa46d2f | Vivan | Male | {hi-IN} |
83
+ | 112e8972-72a4-4359-8c88-a66f2662eb9b | Advertisement | Male | {hi-IN} |
84
+ | be0aae9f-1ab7-4088-8e8a-efe4648e902b | Shayar | Male | {hi-IN} |
85
+ | 0472cf70-1d18-48ba-a918-2bab820a7291 | Maharaj Ji | Male | {hi-IN} |
86
+ | 59062c58-3423-4e70-9154-6ae9e5e5be48 | News | Male | {hi-IN} |
87
+ | 76d34dfb-a062-43f3-907f-b4372fe177be | Mohan Expressive | Male | {hi-IN} |
88
+ | a9a87659-18c5-4751-a426-34ae4f4b19ae | Motivational | Male | {hi-IN} |
89
+ | 9cca245b-4d6a-4d80-ba94-f5cf70938b6a | Dialogue Delivery | Male | {hi-IN} |
90
+ | f883d522-2958-11ef-b685-a218303b6499 | Anchor | Male | {hi-IN} |
91
+ | 69b2d8a1-9664-423a-9d5d-0163b8930a04 | Motivational Lite | Male | {en-US} |
92
+ | d23f90a6-f3c7-4c22-a68f-166e82a039d5 | Youtube Shorts Lite | Male | {en-US} |
93
+ | 3ccb64b4-8a8b-4abe-ab73-40a2ea307b08 | Adam | Male | {en-US} |
94
+ | 154a73c6-c8b8-4e71-99b1-fdf2dfbd1bd0 | Crime Podcast | Male | {en-US} |
95
+ | b4c093ee-05ad-43cc-9e6d-0bdaadc857ba | 1970s Media | Male | {en-US} |
96
+ | d993c661-4fd5-4f3a-ac5f-ce6727e69d5e | Documentary Lite | Male | {en-US} |
97
+ | 9c77f9a3-abe0-47d2-8fed-13b0a21d83b6 | Storyteller Lite | Male | {en-US} |
98
+ | 24deb8ec-add3-4ef8-8cdb-faed5393d99f | News Lite | Male | {en-IN} |
99
+ | 229a3560-ce6c-4969-a88d-749db1231e33 | Mohan Expressive Lite | Male | {en-IN} |
100
+ | 4c2e77e8-7f10-4608-9957-e93939da63dc | Fiction | Female | {hi-IN} |
101
+ | 4089f7a4-b39a-4407-8ee4-4b3bef60b7e8 | Standard | Female | {hi-IN} |
102
+ | f0c65873-9fe1-48a6-ac38-cdf1293bb74e | Meditation Lite | Female | {hi-IN} |
103
+ | 19f41593-8cec-4b16-b375-a6f6ca76db10 | Kamala | Female | {hi-IN} |
104
+ | f40076ea-6aeb-4687-9889-3b773fbaa9f3 | Wamika Lite | Female | {hi-IN} |
105
+ | d4025456-83a0-45da-a15b-3ffcce0cd6b8 | Marketing Lite | Female | {hi-IN} |
106
+ | c990fbbc-7981-4ed6-b3f1-ee109299b628 | Palomi | Female | {hi-IN} |
107
+ | 237e7675-3d90-4d6f-856c-c8def47df71f | Janvi | Female | {hi-IN} |
108
+ | ffade7c0-2958-11ef-b685-a218303b6499 | Anchor | Female | {hi-IN} |
109
+ | 199af31c-3d08-4f80-9879-772f91994797 | Rakul Lite | Female | {hi-IN} |
110
+ | edb596de-1e85-4adb-89aa-a5e58f67fdee | Neha | Female | {hi-IN} |
111
+ | cd9e2d83-063f-4b21-9045-38a7a1fa9f66 | Teacher | Female | {hi-IN} |
112
+ | 57d7a45c-013a-4e63-b26c-c3c24d57d13e | Nisha | Female | {hi-IN} |
113
+ ---
114
+