Skip to content

Document start_recognition_timeout message #157

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

Open
JamesG-Speechmatics wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document start_recognition_timeout message #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/api-ref/realtime-transcription-websocket.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ In the Realtime SaaS, an in-band error message can be followed by a WebSocket cl
| 4005 | `quota_exceeded` |
| 4006 | `timelimit_exceeded` |
| 4013 | `job_error` |
<!-- | 4xxx | `start_recognition_timeout` | TODO -->
Copy link
Collaborator

@mnemitz mnemitz Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need some description here?


{/* Manually generated TOC, since we're using JSX sections */}
export const toc = [
Expand Down
1 change: 1 addition & 0 deletions spec/flow-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ components:
- job_error
- internal_error
- unknown_error
- start_recognition_timeout

ToolTypeEnum:
type: string
Expand Down
2 changes: 2 additions & 0 deletions spec/realtime.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1267,6 +1267,7 @@ components:
| `not_allowed` | User is not allowed to use this message (is not allowed to perform the action the message would invoke). |
| `job_error` | Unable to do any work on this job, the server might have timed out etc. |
| `protocol_error` | Message received was syntactically correct, but could not be accepted due to protocol limitations. This is usually caused by messages sent in the wrong order. |
| `start_recognition_timeout` | The timeout for sending StartRecognition has been exceeded (SaaS only) |
| `quota_exceeded` | Maximum number of concurrent connections allowed for the contract has been reached |
| `timelimit_exceeded` | Usage quota for the contract has been reached |
| `idle_timeout` | Idle duration limit was reached (no audio data sent within the last hour), a closing handshake with code 1008 follows this in-band error. |
Expand All @@ -1289,6 +1290,7 @@ components:
- not_allowed
- job_error
- protocol_error
- start_recognition_timeout
- quota_exceeded
- timelimit_exceeded
- idle_timeout
Expand Down