-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto stash before merge of "master" and "origin/master"
- Loading branch information
1 parent
c0eece6
commit c32dd90
Showing
4 changed files
with
331 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
sidebar_position: 2 | ||
title: API Endpoints | ||
description: Volvox.Apollo API Endpoints For You | ||
slug: /endpoints | ||
--- | ||
|
||
# Endpoints | ||
We expose **public** endpoints that allow you to easily integrate into your application. | ||
|
||
## Analyze Endpoint | ||
To analyze a message all you have to do is send a `GET` request to the following endpoint: | ||
``` | ||
https://apollo.volvox.tech/api/analyze | ||
``` | ||
with the following body: | ||
```json | ||
{ | ||
"content": "Hello World!", | ||
"sender": "Volvox.Apollo", | ||
"source": "Docs" | ||
} | ||
``` | ||
and include the following header: | ||
``` | ||
X-Volvox-Api-Key: <YOUR_API_KEY> | ||
``` | ||
|
||
### Optional Parameters | ||
If you wish to only have select models be returned you can add | ||
```json | ||
modelNames: ["<MODEL_NAME>", "<MODEL_NAME>"] | ||
``` | ||
then only those models will be returned. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.