Skip to content

Commit

Permalink
Auto stash before merge of "master" and "origin/master"
Browse files Browse the repository at this point in the history
  • Loading branch information
BillChirico committed Nov 15, 2023
1 parent c0eece6 commit c32dd90
Show file tree
Hide file tree
Showing 4 changed files with 331 additions and 8 deletions.
34 changes: 34 additions & 0 deletions docs/basics/endpoints.mdx
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.
27 changes: 27 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,33 @@ const config: Config = {
],

themeConfig: {
algolia: {
// The application ID provided by Algolia
appId: '6QKKWL16HE',

// Public API key: it is safe to commit it
apiKey: 'e1aa42d4fc426edfca8b31d1b73f6289',

indexName: 'apollo-volvox',

// Optional: see doc section below
contextualSearch: true,

// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
externalUrlRegex: 'apollo.volvox\\.tech',

// Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
replaceSearchResultPathname: {
from: '/docs/', // or as RegExp: /\/docs\//
to: '/',
},

// Optional: Algolia search parameters
searchParameters: {},

// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',
},
image: 'img/Apollo-Banner.jpg',
navbar: {
title: 'Volvox.Apollo Docs',
Expand Down
263 changes: 263 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c32dd90

Please sign in to comment.