Skip to content

Commit f3c0a56

Browse files
authored
api key description updates (#17)
1 parent accb19d commit f3c0a56

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Modzy Python SDK
2-
2+
33
![Modzy Logo](https://www.modzy.com/wp-content/uploads/2020/06/MODZY-RGB-POS.png)
44

55
<div align="center">
@@ -26,13 +26,30 @@ Use the package manager [pip](https://pip.pypa.io/en/stable/) install the SDK:
2626

2727
## Usage
2828

29+
30+
### Get your API key
31+
32+
33+
34+
API keys are security credentials required to perform API requests to Modzy. Our API keys are composed of an ID that is split by a dot into two parts: a public and private part.
35+
36+
The *public* part is the API keys' visible part only used to identify the key and by itself, it’s unable to perform API requests.
37+
38+
The *private* part is the public part's complement and it’s required to perform API requests. Since it’s not stored on Modzy’s servers, it cannot be recovered. Make sure to save it securely. If lost, you can [replace the API key](https://models.modzy.com/docs/users-keys/api-keys/replace-API-key).
39+
40+
41+
Find your API key in your user profile. To get your full API key click on "Get key":
42+
43+
<img src="key.png" alt="get key" width="10%"/>
44+
45+
2946
### Initialize
3047

31-
Once you have a `model` and `version` identified, authenticate to Modzy with your API key:
48+
Once you have a `model` and `version` identified, get authenticated with your API key.
3249

3350
```python
3451
from modzy import ApiClient, error
35-
client = ApiClient(base_url='https://modzy.example.com/api', api_key='my_key.modzy')
52+
client = ApiClient(base_url='https://modzy.example.com/api', api_key='API Key')
3653
```
3754

3855
### Basic usage

key.png

17.4 KB
Loading

0 commit comments

Comments
 (0)