Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DC-219 Make API endpoints page more visible for Async APIs #394

Merged
merged 12 commits into from
Mar 3, 2022
Merged

DC-219 Make API endpoints page more visible for Async APIs #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dcf2995
change for exp branch
Jan 11, 2022
fd2f352
merge-docs-v1 added for build to workflow
Jan 11, 2022
63a2ff0
changes for dev and prod dispatch events
Jan 12, 2022
5829bef
Merge pull request #333 from symblai/merge-docs-v1
Jan 12, 2022
19cd7c8
Testing changes
amritesh-singh Jan 14, 2022
d7ed975
Merge pull request #335 from amritesh-singh/14-01-22
amritesh-singh Jan 14, 2022
2bd5f6f
Merge branch 'master' of github.com:symblai/symbl-docs
Mukulikaa Feb 8, 2022
99d3957
Merge branch 'master' of github.com:symblai/symbl-docs
Mukulikaa Feb 10, 2022
b0ff0fe
Merge branch 'master' of github.com:symblai/symbl-docs
Mukulikaa Feb 23, 2022
c530542
Merge branch 'master' of github.com:symblai/symbl-docs
Mukulikaa Mar 2, 2022
4b44294
DC-219 Make API endpoints page more visible for Async APIs
Mukulikaa Mar 2, 2022
2b23760
DC-219 Split Async API page into two pages
Mukulikaa Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/async-api/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,33 @@ It can be useful in any use case where you have access to a video file of any ty

* [Submit Video URL](/docs/async-api/overview/video/post-video-url)
* [Append Video URL To Existing Conversation](/docs/async-api/overview/video/put-video-url)


## Endpoints

### Text API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/text` | [Reference](/docs/async-api/overview/text/post-text)
|`PUT` | `https://api.symbl.ai/v1/process/text/{conversationId}` | [Reference](/docs/async-api/overview/text/put-text)


### Audio API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/audio` | [Reference](/docs/async-api/overview/audio/post-audio)
|`POST` | `https://api.symbl.ai/v1/process/audio/url` | [Reference](/docs/async-api/overview/audio/post-audio-url)
|`PUT` | `https://api.symbl.ai/v1/process/audio/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio)
|`PUT` | `https://api.symbl.ai/v1/process/audio/url/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio-url)


### Video API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/video` | [Reference](/docs/async-api/overview/video/post-video)
|`POST` | `https://api.symbl.ai/v1/process/video/url` | [Reference](/docs/async-api/overview/video/post-video-url)
|`PUT` | `https://api.symbl.ai/v1/process/video/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video)
|`PUT` | `https://api.symbl.ai/v1/process/video/url/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video-url)
32 changes: 2 additions & 30 deletions docs/async-api/reference/reference.md → ...sync-api/reference/supported-languages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,9 @@
---
id: reference
title: Async API Reference
title: Supported Languages
sidebar_label: Supported Languages
---

## Endpoints

### Text API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/text` | [Reference](/docs/async-api/overview/text/post-text)
|`PUT` | `https://api.symbl.ai/v1/process/text/{conversationId}` | [Reference](/docs/async-api/overview/text/put-text)


### Audio API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/audio` | [Reference](/docs/async-api/overview/audio/post-audio)
|`POST` | `https://api.symbl.ai/v1/process/audio/url` | [Reference](/docs/async-api/overview/audio/post-audio-url)
|`PUT` | `https://api.symbl.ai/v1/process/audio/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio)
|`PUT` | `https://api.symbl.ai/v1/process/audio/url/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio-url)


### Video API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/video` | [Reference](/docs/async-api/overview/video/post-video)
|`POST` | `https://api.symbl.ai/v1/process/video/url` | [Reference](/docs/async-api/overview/video/post-video-url)
|`PUT` | `https://api.symbl.ai/v1/process/video/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video)
|`PUT` | `https://api.symbl.ai/v1/process/video/url/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video-url)

## Supported Languages

The Async Audio and Async Video APIs can work with languages other than English.
Expand Down
6 changes: 1 addition & 5 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,11 +248,7 @@ items: [
},
{
type: 'doc',
id: 'async-api/reference/reference',
customProps: {
hash: '#supported-languages',
label: 'Supported Languages',
},
id: 'async-api/reference/supported-languages',
},
{
id: "async-api/overview/jobs-api",
Expand Down