Skip to content

Commit 4f77744

Browse files
authored
Update README.md
1 parent b207443 commit 4f77744

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# SLASHML Python client
22

3-
This is a Python client for SLASHML. It lets you run transcription jobs from your Python code or Jupyter notebook.
3+
This is a Python client for SLASHML. It lets you run transcription jobs from your Python code or Jupyter notebook. Do a transcription job with three lines of code
4+
```
5+
import speechtotext
6+
7+
speect_to_text = speechtotext.SpeechToText()
8+
transcribe_id= speect_to_text.transcribe(audio_url,service_provider="aws")
9+
status=speect_to_text.status(transcribe_id,service_provider=service_provider)
10+
11+
```
12+
There is a daily limit (throttling) on the number of calls the user performs, transcription jobs can be done without specifying a token (API key). If the user intends on using the service more frequently, it is recommended to generate an token or API key from the dashboard @ Slashml.com.
413

514
Grab your token from [https://www.slashml.com/dashboard] (>settings> new api key) and authenticate by setting it as an environment variable (or when you initialize the service, see examples):
615
```
716
export SLASHML_API_KEY=[token]
817
```
18+
```
19+
import speechtotext
20+
API_KEY="your_api_key"
21+
speect_to_text = speechtotext.SpeechToText(API_KEY)
22+
transcribe_id= speect_to_text.transcribe(audio_url,service_provider="aws")
23+
status=speect_to_text.status(transcribe_id,service_provider=service_provider)
24+
25+
```
26+
or including it in your code as followes
27+
928

1029
-- update from this part, include examples, sign up, token, service providers, type of servies, benchmarking, link to pricing, Tutorial examples/examples
1130

0 commit comments

Comments
 (0)