Skip to content

Commit

Permalink
feat: add basic API-guides page
Browse files Browse the repository at this point in the history
  • Loading branch information
SaadBazaz committed Jan 30, 2024
1 parent 08b7071 commit a17bf0d
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 3 deletions.
4 changes: 2 additions & 2 deletions _meta.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export default {
"type": "page",
"href": "https://getomni.app"
},
"api": {
"api-docs": {
"title": "API ↗",
"type": "page",
"href": "https://getomni.app/api",
Expand Down Expand Up @@ -48,7 +48,7 @@ export default {
type: 'separator',
"title": <SidebarTitleComponent>For developers</SidebarTitleComponent>
},
'API': {
'api-guide': {
title: 'API',
},
'examples': {
Expand Down
108 changes: 108 additions & 0 deletions api-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
title: "API Docs"
---

import {Callout} from 'nextra/components'

# Using the API

We've made our API available to developers so they can utilize the raw power of Omni, and build on top of it.

See the [API Reference](https://getomni.app/api) for more details.

## SDKs

<Callout type='info'>
We're currently building this feature.
</Callout>

We're building SDKs in Node and Python to enable developers to whip up scripts, quicker.

## End-to-end Models

When invoking our API, you may choose a model according to your use case. The details are below:

| Name | Speed | Quality | Supported features
| :----- | :----: | :----: |----: |
| `babelfish-micro` | Fastest | Low | Audio only |
| `babelfish` | Fast | Medium | Audio, video |
| `solomon` | Slow | High | Audio, video |

## All languages

The following is a list of **all** languages supported by Omni, whether as a source or a target language.
This may be useful as a reference for *language codes* and corresponding language names.
{
<table>
<thead>
<tr>
<th>Language</th>
<th>Code</th>
</tr>
</thead>
<tbody>
{[
{
label: 'English',
value: 'en'
},
{
label: 'German',
value: 'de'
},
{
label: 'French',
value: 'fr'
},
{
label: 'Spanish',
value: 'es'
},
{
label: 'Mandarin Chinese',
value: 'zh-CN'
},
{
label: 'Italian',
value: 'it'
},
{
label: 'Polish',
value: 'pl'
},
{
label: 'Portuguese',
value: 'pt'
},
{
label: 'Turkish',
value: 'tr'
},
{
label: 'Russian',
value: 'ru'
},
{
label: 'Dutch',
value: 'nl'
},
{
label: 'Czech',
value: 'cs'
},
{
label: 'Arabic',
value: 'ar'
},
{
label: 'Japanese',
value: 'ja'
}
].map(item => (
<tr key={item.label}>
<td>{item.label}</td>
<td>{item.value}</td>
</tr>
))}
</tbody>
</table>}
2 changes: 1 addition & 1 deletion index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import styles from './index.module.css'
import {BlogLatestCard} from "../components/blogIndex"
import SupportedEngines from "../components/SupportedEngines.mdx"

<img src={"/docs/images/balls-in-os-ezgif.com-optimize.gif"} style={{width: "100%", mixBlendMode: 'lighten'}} autoPlay muted loop />
<img src={"/docs/images/balls-in-os-ezgif.com-optimize.gif"} style={{width: "100%", mixBlendMode: 'exclusion'}} autoPlay muted loop />
<BlogLatestCard />
<div style={{textAlign: "center"}}>
<h1 style={{fontWeight: 400, lineHeight: "92%", fontSize: "3rem", margin: "2rem 0rem 1rem"}}>Videos for everyone</h1>
Expand Down

0 comments on commit a17bf0d

Please sign in to comment.