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.

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-381, DC-382 #465

Merged
merged 1 commit into from
Apr 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/streamingapi/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,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)


Expand Down
5 changes: 3 additions & 2 deletions docs/streamingapi/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,21 @@ 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

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.

### 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

#### <a name="message-body"></a>Main Message Body

Field | Required | Supported Value | Description
Expand Down