mirror of
https://github.com/NovaOSS/nova-api.git
synced 2024-11-25 20:13:57 +01:00
Docs
This commit is contained in:
parent
162e128366
commit
ee0c9e9d96
32
README.md
32
README.md
|
@ -12,7 +12,7 @@ Reverse proxy server for "Closed"AI's API.
|
||||||
![Badge showing the number of forks](https://img.shields.io/github/forks/novaoss/nova-api?style=social)
|
![Badge showing the number of forks](https://img.shields.io/github/forks/novaoss/nova-api?style=social)
|
||||||
![Badge showing the number of watchers](https://img.shields.io/github/watchers/novaoss/nova-api?style=social)
|
![Badge showing the number of watchers](https://img.shields.io/github/watchers/novaoss/nova-api?style=social)
|
||||||
|
|
||||||
![Nova-API Conver/Banner Image. A picture of a galaxy with the caption "the core API server"](https://i.ibb.co/ZBhkS56/nova-api.png)
|
![Nova-API Conver/Banner Image - a picture of a galaxy with the caption "the core API server"](https://i.ibb.co/ZBhkS56/nova-api.png)
|
||||||
|
|
||||||
> "*OpenAI is very closed*"
|
> "*OpenAI is very closed*"
|
||||||
>
|
>
|
||||||
|
@ -20,13 +20,29 @@ Reverse proxy server for "Closed"AI's API.
|
||||||
|
|
||||||
We aim to fix that!
|
We aim to fix that!
|
||||||
|
|
||||||
|
## Star History
|
||||||
|
|
||||||
|
|
||||||
|
###### *I founded FoxGPT (called *NovaGPT* back then)
|
||||||
|
Old, slow, deprecated* FoxGPT vs new NovaAI repository star count:
|
||||||
|
|
||||||
|
<a href="https://star-history.com/#NovaOSS/nova-api&FoxGPT/gpt&Date">
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=NovaOSS/nova-api,FoxGPT/gpt&type=Date&theme=dark" />
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=NovaOSS/nova-api,FoxGPT/gpt&type=Date" />
|
||||||
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=NovaOSS/nova-api,FoxGPT/gpt&type=Date" />
|
||||||
|
</picture>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<img alt="'Emotional damage' meme, with a man with a worried face and the yellow caption 'emotional damage'" src="https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Findianmemetemplates.com%2Fwp-content%2Fuploads%2Femotional-damage-1024x575.jpg&f=1&nofb=1&ipt=b325721ee0a7b9e11603a9bd484c8042b82e1704e639887107c6ce3e0d9b389e&ipo=images" height=100>
|
||||||
|
|
||||||
## NovaOSS APIs
|
## NovaOSS APIs
|
||||||
Our infrastructure might seem a bit confusing, but it's actually quite simple. Just the first one really matters for you, if you want to access our AI API. The other ones are just for the team.
|
Our infrastructure might seem a bit confusing, but it's actually quite simple. Just the first one really matters for you, if you want to access our AI API. The other ones are just for the team.
|
||||||
|
|
||||||
### AI API
|
### AI API
|
||||||
**Public** (everyone can use it with a valid API key)
|
**Public** (everyone can use it with a valid API key)
|
||||||
|
|
||||||
Official endpoints: `https://api.nova-oss.com/v1/...`
|
Endpoint: `https://api.nova-oss.com/v1/...`
|
||||||
Documentation & info: [nova-oss.com](https://nova-oss.com)
|
Documentation & info: [nova-oss.com](https://nova-oss.com)
|
||||||
|
|
||||||
- Access to AI models
|
- Access to AI models
|
||||||
|
@ -36,16 +52,24 @@ Documentation & info: [nova-oss.com](https://nova-oss.com)
|
||||||
### User/Account management API
|
### User/Account management API
|
||||||
**Private** (NovaOSS operators only!)
|
**Private** (NovaOSS operators only!)
|
||||||
|
|
||||||
Official endpoints: `https://api.nova-oss.com/...`
|
Endpoint: `https://api.nova-oss.com/...`
|
||||||
Documentation: [api.nova-oss.com/docs](https://api.nova-oss.com/docs)
|
Documentation: [api.nova-oss.com/docs](https://api.nova-oss.com/docs)
|
||||||
|
|
||||||
- Access to user accounts
|
- Access to user accounts
|
||||||
- Implemented in [NovaCord](https://nova-oss.com/novacord)
|
- Implemented in [NovaCord](https://nova-oss.com/novacord)
|
||||||
|
|
||||||
|
### NovaCord Bot API
|
||||||
|
**Private** (NovaOSS operators only!)
|
||||||
|
|
||||||
|
Endpoint: `http://0.0.0.0:3224/...`
|
||||||
|
|
||||||
|
- acess to Discord server member roles (for receiving the Discord level, ...)
|
||||||
|
- hosted using [NovaCord](https://nova-oss.com/novacord)
|
||||||
|
|
||||||
### Website API
|
### Website API
|
||||||
**Private** (NovaOSS operators only!)
|
**Private** (NovaOSS operators only!)
|
||||||
|
|
||||||
Official endpoints: `https://nova-oss.com/api/...`
|
Endpoint: `https://nova-oss.com/api/...`
|
||||||
|
|
||||||
This one's code can be found in the following repository: [github.com/novaoss/nova-web](https://github.com/novaoss/nova-web)
|
This one's code can be found in the following repository: [github.com/novaoss/nova-web](https://github.com/novaoss/nova-web)
|
||||||
|
|
||||||
|
|
BIN
image-1.png
Normal file
BIN
image-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 566 KiB |
Loading…
Reference in a new issue