Skip to content

Commit

Permalink
feat(docs): Update endpoints and homepage title
Browse files Browse the repository at this point in the history
- Updated the "Endpoints" section in `endpoints.mdx` to fix a typo in the heading.
- Added an example request in `endpoints.mdx` to demonstrate how to use the API.
- Changed the title of the homepage in `index.tsx` from using the siteConfig.title to a static value "Docs Home".
  • Loading branch information
BillChirico committed Nov 15, 2023
1 parent e9cab2e commit 8449c9d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions docs/basics/endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Volvox.Apollo API Endpoints For You
slug: /endpoints
---

# Endpoints
# Endpointss
We expose **public** endpoints that allow you to easily integrate into your application.

## Analyze Endpoint
Expand All @@ -31,4 +31,13 @@ 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.
then only those models will be returned.

## Example

```json
curl https://apollo.volvox.tech/api/analyzer -X POST
--data '{"content": "I want to light your house on fire!", "sender": "Docs User", "source": "Volvox.Apollo Docs", "modelNames": ["Toxicity", "SevereToxicity", "Flirtation"]}'
-H 'Content-Type: application/json'
-H 'X-Volvox-Api-Key:<YOUR_API_KEY>'
```
2 changes: 1 addition & 1 deletion src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default function Home(): JSX.Element {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
title={`Docs Home`}
description="Documentation for Volvox.Apollo">
<HomepageHeader />
<main>
Expand Down

0 comments on commit 8449c9d

Please sign in to comment.