diff --git a/docs/async-api/code-snippets/how-to-use-sentiment-analysis.md b/docs/async-api/code-snippets/how-to-use-sentiment-analysis.md index ab638e9b..93724596 100644 --- a/docs/async-api/code-snippets/how-to-use-sentiment-analysis.md +++ b/docs/async-api/code-snippets/how-to-use-sentiment-analysis.md @@ -23,11 +23,10 @@ You must wait for the job to complete processing before you proceed with getting While we provide you with a default video URL for the API to process, which can be downloaded [here](https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4), you can replace that with any other video URL. -### Request Example +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. -:::info -Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: +### Request Example diff --git a/docs/async-api/overview/audio/post-audio-url.md b/docs/async-api/overview/audio/post-audio-url.md index e24088c8..b67f8a34 100644 --- a/docs/async-api/overview/audio/post-audio-url.md +++ b/docs/async-api/overview/audio/post-audio-url.md @@ -18,6 +18,9 @@ It can be utilized for any use case where you have access to recorded audio stor The URL provided must be a publicly available URL. Currently, we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + ### API Endpoint `POST https://api.symbl.ai/v1/process/audio/url` @@ -25,8 +28,6 @@ The URL provided must be a publicly available URL. Currently, we do not support ### Example API Call -Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). - mp4 file formats video. If you have any other type of file, you need to first convert the file to the supported format in order to use the API. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### API Endpoint `POST https://api.symbl.ai/v1/process/video/url` - ### Example API Call -Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). - mp4 file formats. If you have any other type of file, you need to first convert the file to the supported format in order to use the API. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + ### API Endpoint `POST https://api.symbl.ai/v1/process/video` - ### Example API Call -Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). - diff --git a/docs/conversation-api/concepts/speech-to-text.md b/docs/conversation-api/concepts/speech-to-text.md index 8db0fc01..912938ae 100644 --- a/docs/conversation-api/concepts/speech-to-text.md +++ b/docs/conversation-api/concepts/speech-to-text.md @@ -4,6 +4,7 @@ title: Speech-to-Text description: Get real-time speech-to-text data and analytics from your conversations with Symbl.ai APIs. Learn more. sidebar_label: Introduction slug: /concepts/speech-to-text/ +pagination_label: Speech-to-text --- diff --git a/docs/conversation-api/concepts/summarization.md b/docs/conversation-api/concepts/summarization.md index 7d730d2b..3c2dbd76 100644 --- a/docs/conversation-api/concepts/summarization.md +++ b/docs/conversation-api/concepts/summarization.md @@ -3,6 +3,7 @@ id: summarization title: Summarization (Labs) description: Use Symbl.ai’s summarization API to capture key points in a conversation and create succinct summaries. Learn more. sidebar_label: Introduction +pagination_label: Summarization slug: /concepts/summarization/ --- diff --git a/docs/conversation-api/concepts/summary-topic.md b/docs/conversation-api/concepts/summary-topic.md index 45d7a47e..edd12f82 100644 --- a/docs/conversation-api/concepts/summary-topic.md +++ b/docs/conversation-api/concepts/summary-topic.md @@ -4,6 +4,7 @@ title: Topics description: Automatically identify and extract topics from conversations with Symbl.ai's Topic API. sidebar_label: Introduction slug: /concepts/topics/ +pagination_label: Topics --- diff --git a/docs/conversation-api/concepts/topic-hierarchy.md b/docs/conversation-api/concepts/topic-hierarchy.md index 1bd6d17e..fcc969fd 100644 --- a/docs/conversation-api/concepts/topic-hierarchy.md +++ b/docs/conversation-api/concepts/topic-hierarchy.md @@ -3,6 +3,7 @@ id: topic-hierarchy title: Topic Hierarchy (Beta) sidebar_label: Introduction slug: /concepts/topic-hierarchy/ +pagination_label: Topic Hierarchy --- import Tabs from '@theme/Tabs'; diff --git a/docs/conversation-api/concepts/trackers.md b/docs/conversation-api/concepts/trackers.md index 8bfc3c4d..d9663034 100644 --- a/docs/conversation-api/concepts/trackers.md +++ b/docs/conversation-api/concepts/trackers.md @@ -3,6 +3,7 @@ id: trackers title: Trackers (Beta) sidebar_label: Introduction slug: /concepts/trackers/ +pagination_label: Trackers --- import Tabs from '@theme/Tabs'; diff --git a/docs/conversation-api/concepts/ui-components.md b/docs/conversation-api/concepts/ui-components.md index 38e9b82d..0596d132 100644 --- a/docs/conversation-api/concepts/ui-components.md +++ b/docs/conversation-api/concepts/ui-components.md @@ -3,6 +3,7 @@ id: ui-components title: Reusable and Customizable UI Components sidebar_label: Introduction slug: /conversation-api/concepts/ui-components/ +pagination_label: Reusable and Customizable UI Components --- import Tabs from '@theme/Tabs'; diff --git a/docs/conversation-api/introduction.md b/docs/conversation-api/introduction.md index 5fd7584f..7af2b232 100644 --- a/docs/conversation-api/introduction.md +++ b/docs/conversation-api/introduction.md @@ -4,6 +4,7 @@ title: Introduction description: Use Symbl.ai Conversation APIs to get speech-to-text data and actionable insights from your conversations. Learn more. sidebar_label: Introduction slug: /conversation-api/introduction/ +pagination_label: Conversation API --- diff --git a/docs/guides.md b/docs/guides.md index 0947511d..ef372331 100644 --- a/docs/guides.md +++ b/docs/guides.md @@ -3,6 +3,7 @@ id: guides-intro title: Guides sidebar_label: Getting Started slug: /guides/ +pagination_next: null --- --- diff --git a/docs/integrations/integrations-intro.md b/docs/integrations/integrations-intro.md index c1b0d790..1b2501cf 100644 --- a/docs/integrations/integrations-intro.md +++ b/docs/integrations/integrations-intro.md @@ -2,6 +2,7 @@ id: integrations-intro title: Integrations slug: /integrations/integrations-intro/ +pagination_next: null --- import Tabs from '@theme/Tabs'; diff --git a/docs/introduction.md b/docs/introduction.md index a0c92c63..0aacfea2 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -3,6 +3,7 @@ id: introduction title: Symbl Documentation sidebar_label: Documentation slug: / +pagination_next: null --- --- diff --git a/docs/javascript-sdk/overview/introduction.md b/docs/javascript-sdk/overview/introduction.md index c389a70f..1fe8f9e4 100644 --- a/docs/javascript-sdk/overview/introduction.md +++ b/docs/javascript-sdk/overview/introduction.md @@ -3,6 +3,7 @@ id: introduction title: Symbl SDK (Node.js) sidebar_label: Introduction slug: /javascript-sdk/introduction/ +pagination_label: JavaScript SDK --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/labs.md b/docs/labs.md index a76adf21..05cc24ab 100644 --- a/docs/labs.md +++ b/docs/labs.md @@ -3,7 +3,7 @@ id: labs-intro title: Symbl Labs sidebar_label: Symbl Labs slug: /labs/ - +pagination_next: null --- --- Symbl Labs is our experimental wing designed to share our bleeding edge AI research on human conversations with anyone who wants to explore its limits. diff --git a/docs/labs/abstract-topics-labs.md b/docs/labs/abstract-topics-labs.md index 650bcb9b..061b3791 100644 --- a/docs/labs/abstract-topics-labs.md +++ b/docs/labs/abstract-topics-labs.md @@ -3,6 +3,7 @@ id: abstract-topics-labs title: Abstract Topics (Labs) sidebar_label: Introduction slug: /guides/abstract-topics-labs/ +pagination_label: Abstract Topics --- import Tabs from '@theme/Tabs'; diff --git a/docs/management-api/conversation-groups/conversation-groups-intro.md b/docs/management-api/conversation-groups/conversation-groups-intro.md index b2ff8f6a..dcce7e41 100644 --- a/docs/management-api/conversation-groups/conversation-groups-intro.md +++ b/docs/management-api/conversation-groups/conversation-groups-intro.md @@ -1,8 +1,9 @@ --- id: conversation-groups-intro title: Conversation Groups (Beta) -sidebar_label: Overview +sidebar_label: Introduction slug: /management-api/conversation-groups/conversation-groups-intro/ +pagination_label: Conversation Groups --- import Tabs from '@theme/Tabs'; diff --git a/docs/management-api/introduction.md b/docs/management-api/introduction.md index e19f3fef..d99d82f2 100644 --- a/docs/management-api/introduction.md +++ b/docs/management-api/introduction.md @@ -3,6 +3,7 @@ id: introduction title: Management API (Beta) sidebar_label: Introduction slug: /management-api/introduction/ +pagination_label: Management API --- :::note In Beta Phase This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai. diff --git a/docs/management-api/trackers/overview.md b/docs/management-api/trackers/overview.md index ae7e92bb..3b74b964 100644 --- a/docs/management-api/trackers/overview.md +++ b/docs/management-api/trackers/overview.md @@ -3,6 +3,7 @@ id: trackers-overview title: Trackers API (Beta) sidebar_label: Introduction slug: /management-api/trackers/overview/ +pagination_label: Trackers API --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/python-sdk/overview.md b/docs/python-sdk/overview.md index 599a6c80..98747a67 100644 --- a/docs/python-sdk/overview.md +++ b/docs/python-sdk/overview.md @@ -3,6 +3,7 @@ id: python-sdk title: Symbl Python SDK sidebar_label: Introduction slug: /python-sdk/overview/ +pagination_label: Python SDK --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/sdk-intro.md b/docs/sdk-intro.md index 3ed844db..be5b3d8b 100644 --- a/docs/sdk-intro.md +++ b/docs/sdk-intro.md @@ -3,7 +3,7 @@ id: sdk-intro title: Symbl SDKs sidebar_label: Symbl SDKs slug: /sdk-intro/ - +pagination_next: null --- import Tabs from '@theme/Tabs'; diff --git a/docs/streamingapi/introduction.md b/docs/streamingapi/introduction.md index e26737ff..cdee3332 100644 --- a/docs/streamingapi/introduction.md +++ b/docs/streamingapi/introduction.md @@ -4,6 +4,7 @@ title: Streaming API description: Streaming API can provide real-time transcription and extract actionable insights from your conversations. Learn how to implement Symbl.ai’s Streaming API now. sidebar_label: Introduction slug: /streamingapi/introduction/ +pagination_label: Streaming API --- @@ -35,7 +36,7 @@ Here is a list of code snippets to help you get started on your journey with the - [Start and Stop Streaming API Connection](/docs/streamingapi/code-snippets/start-and-stop-connection) - [Receive Live Captioning](/docs/streamingapi/code-snippets/receive-live-captioning) - [Receive Live Topics](/docs/streamingapi/code-snippets/receive-live-topics) -- [Receive Live AI Insights](/docs/streamingapi/code-snippets/receive-ai-insights) +- [Receive Live AI Insights](/docs/streamingapi/code-snippets/receive-live-insights/) - [Receive Speech to Text for a different language in a conversation](/docs/streamingapi/code-snippets/receive-speech-to-text-for-different-languages) diff --git a/docs/streamingapi/reference/reference.md b/docs/streamingapi/reference/reference.md index 7759303e..eb53506b 100644 --- a/docs/streamingapi/reference/reference.md +++ b/docs/streamingapi/reference/reference.md @@ -16,7 +16,6 @@ Symbl's Streaming API is based on the WebSocket protocol and can be used for rea Currently, Streaming API is supported in English only. However, the support for Spanish is available as a part of [Symbl Labs](/docs/labs/). ::: -## Request Parameters ### Authentication @@ -24,12 +23,14 @@ Before using this API, you must generate your authentication token (`AUTH_TOKEN` ### Endpoint -`wss://api.symbl.ai/v1/streaming/{CONVERSATION_ID}?access_token=ACCESS_TOKEN` +`wss://api.symbl.ai/v1/streaming/{CONNECTION_ID}?access_token=ACCESS_TOKEN` :::note Backward Compatibility The previous endpoint `wss://api.symbl.ai/v1/realtime/insights/` is now updated to `wss://api.symbl.ai/v1/streaming/` to standardize our API nomenclature. This change is backward compatible. However, we recommend you to use the new endpoint. ::: +### Request Parameters + #### Main Message Body Field | Required | Supported Value | Description diff --git a/docs/support.md b/docs/support.md index ed498470..a788f7d7 100644 --- a/docs/support.md +++ b/docs/support.md @@ -3,6 +3,7 @@ id: support title: Support sidebar_label: Support slug: /support/ +pagination_next: null --- --- diff --git a/docs/telephony/code-snippets/connect-to-pstn.md b/docs/telephony/code-snippets/connect-to-pstn.md index 2c3a4ed1..73f081d0 100644 --- a/docs/telephony/code-snippets/connect-to-pstn.md +++ b/docs/telephony/code-snippets/connect-to-pstn.md @@ -12,12 +12,15 @@ import TabItem from '@theme/TabItem'; The following code example shows how you can connect the Telephony API to your cell phone or any other type of phone number using PSTN (**Currently, only US phone numbers work**). Making a phone call is also the quickest way to test Symbl’s Telephony API. It can make an outbound call to a phone number using a traditional public switched telephony network ([PSTN](https://en.wikipedia.org/wiki/Public_switched_telephone_network)). -#### Code Example - :::info The Symbl SDK (Node.js) snippet must be run using Node.js, while the Native Javascript snippet can be run in your web browser. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + +#### Code Example + Code Example - :::info The Symbl SDK (Node.js) snippet must be run using Node.js, while the Native Javascript snippet can be run in your web browser. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + +#### Code Example + Full Code Example :::info The Symbl SDK (Node.js) snippet must be run using Node.js, while the Native Javascript snippet can be run in your web browser. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + +#### Full Code Example + Full Code Example :::info The Symbl SDK (Node.js) snippet must be run using Node.js, while the Native Javascript snippet can be run in your web browser. ::: +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + +### Full Code Example + diff --git a/docs/telephony/reference/reference.md b/docs/telephony/reference/reference.md index 243d8998..558e21ed 100644 --- a/docs/telephony/reference/reference.md +++ b/docs/telephony/reference/reference.md @@ -9,7 +9,8 @@ import TabItem from '@theme/TabItem'; --- -## Endpoint +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### HTTP REQUEST diff --git a/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md b/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md index ba6aee34..689f34e7 100644 --- a/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md +++ b/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md @@ -53,6 +53,8 @@ From the root directory of your project, run the following command to add `@symb ```bash npm i --save @symblai/symbl-js ``` +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### Retrieve your Symbl API credentials diff --git a/docs/telephony/tutorials/get-live-transcription-telephony-api.md b/docs/telephony/tutorials/get-live-transcription-telephony-api.md index 2bc07851..3119715f 100644 --- a/docs/telephony/tutorials/get-live-transcription-telephony-api.md +++ b/docs/telephony/tutorials/get-live-transcription-telephony-api.md @@ -44,13 +44,14 @@ From the root directory of your project, run the following command to add `symbl ```bash $ npm i --save symbl-node ``` +### Authentication +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### Retrieve your credentials Your credentials include your appId and appSecret. You can find them on the home page of the platform. ![credentials page](/img/credentials.png) - ### Initialize SDK Create a new file named index.js in your project and add the following lines to initialize the Symbl SDK: diff --git a/docs/tutorials.md b/docs/tutorials.md index 7d474343..31ff7f90 100644 --- a/docs/tutorials.md +++ b/docs/tutorials.md @@ -3,6 +3,7 @@ id: tutorials-page title: Tutorials sidebar_label: Tutorials slug: /tutorials/ +pagination_next: null --- --- diff --git a/docusaurus.config.js b/docusaurus.config.js index 60b5d464..3ca646a5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -227,13 +227,14 @@ module.exports = { munchkin: { applicationId: process.env.MUNCHKIN_ID, }, - announcementBar: { - id: 'new_docs_announcement', // Any value that will identify this message. - content:'New Release Announcement: We have released the Symbl-Agora Marketplace extension with Agora SDK for Android applications. Head to our Integrations section to learn more.', - backgroundColor: '#fafbfc', // Defaults to `#fff`. - textColor: '#091E42', // Defaults to `#000`. - isCloseable: true, // Defaults to `true`. - }, + + // announcementBar: { + // id: 'new_docs_announcement', // Any value that will identify this message. + // content:'New Release Announcement: We have released the Symbl-Agora Marketplace extension with Agora SDK for Android applications. Head to our Integrations section to learn more.', + // backgroundColor: '#fafbfc', // Defaults to `#fff`. + // textColor: '#091E42', // Defaults to `#000`. + // isCloseable: true, // Defaults to `true`. + // }, colorMode: {