{ "request_id": "req_1234567890", "transcript": "Hello this is a test message", "text": "Hello, this is a test message.", "duration_ms": 2500, "created_at": "2024-01-01T12:00:00Z", "language": "en", "words": [ { "word": "hello", "offset": 0, "duration": 500, "confidence": 0.98 } ], "speakers": [ { "speaker_id": "speaker_1", "text": "Hello, this is a test message.", "offset": 0, "duration": 2500 } ]}
{ "request_id": "req_1234567890", "transcript": "Hello this is a test message", "text": "Hello, this is a test message.", "duration_ms": 2500, "created_at": "2024-01-01T12:00:00Z", "language": "en", "words": [ { "word": "hello", "offset": 0, "duration": 500, "confidence": 0.98 } ], "speakers": [ { "speaker_id": "speaker_1", "text": "Hello, this is a test message.", "offset": 0, "duration": 2500 } ]}
Language or locale code (optional, default: "en-US"). Supports both ISO 639-1 language codes (e.g. "en", "zh")
and BCP 47 locale codes (e.g. "en-US", "zh-CN"). When a language code is provided,
the system will automatically resolve it to the most common locale (e.g. "en" -> "en-US").
Improves recognition performance if provided, otherwise auto-detected by service.
Whether to enable LLM post-processing on the STT transcript (optional, default false).
When enabled, the recognized transcript is passed to the LLM with the specified llm_prompt,
and the transformed result is returned in the text field.
If LLM transform fails, text falls back to the raw transcript (no error is returned).
This feature requires whitelist access. Contact support@voxnexus.ai to request access.
LLM transform instruction (required when enable_llm_transform=true).
Describes what the LLM should do with the transcript, e.g. "correct punctuation",
"rewrite in a humorous tone", "translate to English", "summarize key points".
The LLM applies this instruction freely — the service does not interpret its semantics.
LLM model ID (optional). Falls back to the server-configured default model when not specified.
Routing is prefix-based: claude-* models route to Anthropic; all other model IDs route to OpenAI.
Examples: claude-haiku-4-5-20251001 (Anthropic), gpt-4.1 (OpenAI).
Speaker information (if speaker diarization is enabled)
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VoxNexus","colors":{"primary":"#1a365d","light":"#1a365d","dark":"#1a365d"},"logo":{"light":"https://mintcdn.com/senpng/3_76exvqAfUXx55L/logo/light.png?fit=max\u0026auto=format\u0026n=3_76exvqAfUXx55L\u0026q=85\u0026s=6dac020b56bdc0d66f570d2576f49c7f","dark":"https://mintcdn.com/senpng/3_76exvqAfUXx55L/logo/dark.png?fit=max\u0026auto=format\u0026n=3_76exvqAfUXx55L\u0026q=85\u0026s=83549b14f12ed0666f5b13697f001140","href":"https://voxnexus.ai"},"favicon":{"light":"https://mintcdn.com/senpng/3_76exvqAfUXx55L/favicon-light.png?fit=max\u0026auto=format\u0026n=3_76exvqAfUXx55L\u0026q=85\u0026s=8f48cc8bbe0aa190d834d64abd5a3ec5","dark":"https://mintcdn.com/senpng/3_76exvqAfUXx55L/favicon-dark.png?fit=max\u0026auto=format\u0026n=3_76exvqAfUXx55L\u0026q=85\u0026s=6b77ac680f641b93e169eb609c171590"},"api":{"playground":{"display":"interactive","proxy":false}},"appearance":{"strict":true},"navbar":{"links":[{"href":"https://voxnexus.ai","label":"Homepage"},{"href":"https://voxnexus.ai/pricing","label":"Pricing"},{"href":"mailto:hi@voxnexus.ai","label":"Support"}],"primary":{"type":"button","label":"Console","href":"https://voxnexus.ai/app/home"}},"integrations":{"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"senpng","hasAudioNarration":false,"actualSubdomain":"senpng","customDomains":["docs.voxnexus.ai"],"gitSource":{"type":"github","owner":"cybernexus-org","repo":"voxnexus-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad31a1e849652397855c20d","collectionId":"10dd0bb3-49f0-4b10-8c21-954d7f27f63e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad31a1e849652397855c20d"},"entitlements":{},"buildId":"6ad31a1e849652397855c20d","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API reference","count":25},{"language":"default","tag":"REST API","count":20},{"language":"default","tag":"tts","count":9},{"language":"default","tag":"tts-intervention","count":8},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"WebSocket API","count":4},{"language":"default","tag":"Platform","count":4},{"language":"default","tag":"voices","count":3},{"language":"default","tag":"Websockets","count":3},{"language":"default","tag":"Getting started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/stt/speech-to-text","slug":"/api-reference/stt/speech-to-text","pageMetadata":{"title":"Speech to Text","description":"Convert audio file to text, returns complete recognition result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/stt","href":"/api-reference/stt/speech-to-text","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Convert audio file to text, returns complete recognition result\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Speech to Text","description":"Convert audio file to text, returns complete recognition result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/stt","href":"/api-reference/stt/speech-to-text","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Speech to Text","description":"Convert audio file to text, returns complete recognition result","operationId":"speechToText","tags":["stt"],"security":["996b14fa-47e9-47f2-9c1e-55282105ded4"],"parameters":["2a629126-a112-4baa-9d15-38bea8741f21","7df575e7-f492-4a2e-bb23-30c6d5be63f4","79216053-553d-48b6-8357-5443c03f4152","b04a31ad-a401-4355-837c-2d941ce8c355","a4ef1ee2-0fe2-4617-b623-25b90ba2b771","d6778078-0062-44bd-a9ef-33739fbd02d8","00d0cc10-4769-400f-80ad-29d154345710","05b3bd25-68b1-4aa5-8392-070db03e4e11","33dc54e2-aabe-4bb7-8352-8b859d602dbe"],"requestBody":"7a9f4a34-f602-4e37-9887-14d3d8faa039","responses":{"200":"8c097229-2cdb-4a5c-91ac-4bc368424943","400":"00890c83-f302-4cc0-a059-8fefaae196fe","401":"6727cc7f-e004-4259-9df9-db183cd3f271","429":"7e82f815-e1a1-410b-a60b-671f98060547","500":"09b70598-ad9a-46c2-8aa3-e55b4304ec5a"},"method":"post","type":"path","servers":["2d9f2c45-633a-41ff-a618-432f00e916ff"],"path":"/v1/stt","baseUrlOptions":["https://api.voxnexus.ai"],"title":"Speech to Text","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"2a629126-a112-4baa-9d15-38bea8741f21":{"name":"model_id","in":"query","description":"Model identifier (required). Specifies which model to use for STT.\n","required":true,"schema":{"type":"string","example":"vn-stt-basic","isRequired":true,"description":"Model identifier (required). Specifies which model to use for STT.\n","uniqueKey":"","typeLabel":"string"}},"7df575e7-f492-4a2e-bb23-30c6d5be63f4":{"name":"language","in":"query","description":"Language or locale code (optional, default: \"en-US\"). Supports both ISO 639-1 language codes (e.g. \"en\", \"zh\")\nand BCP 47 locale codes (e.g. \"en-US\", \"zh-CN\"). When a language code is provided,\nthe system will automatically resolve it to the most common locale (e.g. \"en\" -> \"en-US\").\nImproves recognition performance if provided, otherwise auto-detected by service.\n","required":false,"schema":{"type":"string","default":"en-US","example":"en-US","isRequired":false,"description":"Language or locale code (optional, default: \"en-US\"). Supports both ISO 639-1 language codes (e.g. \"en\", \"zh\")\nand BCP 47 locale codes (e.g. \"en-US\", \"zh-CN\"). When a language code is provided,\nthe system will automatically resolve it to the most common locale (e.g. \"en\" -> \"en-US\").\nImproves recognition performance if provided, otherwise auto-detected by service.\n","uniqueKey":"","typeLabel":"string"}},"79216053-553d-48b6-8357-5443c03f4152":{"name":"sample_rate","in":"query","description":"Sample rate (required, unit: Hz, e.g. 16000, 22050, 44100, 48000)","required":true,"schema":{"type":"integer","minimum":1,"example":16000,"isRequired":true,"description":"Sample rate (required, unit: Hz, e.g. 16000, 22050, 44100, 48000)","uniqueKey":"","typeLabel":"integer"}},"b04a31ad-a401-4355-837c-2d941ce8c355":{"name":"enable_timestamps","in":"query","description":"Whether to return timestamps (optional, default false)","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"Whether to return timestamps (optional, default false)","uniqueKey":"","typeLabel":"boolean"}},"a4ef1ee2-0fe2-4617-b623-25b90ba2b771":{"name":"enable_speaker_diarization","in":"query","description":"Whether to enable speaker diarization (optional, default false)","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"Whether to enable speaker diarization (optional, default false)","uniqueKey":"","typeLabel":"boolean"}},"d6778078-0062-44bd-a9ef-33739fbd02d8":{"name":"enable_llm_transform","in":"query","description":"Whether to enable LLM post-processing on the STT transcript (optional, default false).\nWhen enabled, the recognized `transcript` is passed to the LLM with the specified `llm_prompt`,\nand the transformed result is returned in the `text` field.\nIf LLM transform fails, `text` falls back to the raw transcript (no error is returned).\n**This feature requires whitelist access. Contact support@voxnexus.ai to request access.**\n","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"Whether to enable LLM post-processing on the STT transcript (optional, default false).\nWhen enabled, the recognized `transcript` is passed to the LLM with the specified `llm_prompt`,\nand the transformed result is returned in the `text` field.\nIf LLM transform fails, `text` falls back to the raw transcript (no error is returned).\n**This feature requires whitelist access. Contact support@voxnexus.ai to request access.**\n","uniqueKey":"","typeLabel":"boolean"}},"00d0cc10-4769-400f-80ad-29d154345710":{"name":"llm_prompt","in":"query","description":"LLM transform instruction (required when `enable_llm_transform=true`).\nDescribes what the LLM should do with the transcript, e.g. \"correct punctuation\",\n\"rewrite in a humorous tone\", \"translate to English\", \"summarize key points\".\nThe LLM applies this instruction freely — the service does not interpret its semantics.\n","required":false,"schema":{"type":"string","example":"Correct punctuation and remove filler words","isRequired":false,"description":"LLM transform instruction (required when `enable_llm_transform=true`).\nDescribes what the LLM should do with the transcript, e.g. \"correct punctuation\",\n\"rewrite in a humorous tone\", \"translate to English\", \"summarize key points\".\nThe LLM applies this instruction freely — the service does not interpret its semantics.\n","uniqueKey":"","typeLabel":"string"}},"05b3bd25-68b1-4aa5-8392-070db03e4e11":{"name":"llm_model_id","in":"query","description":"LLM model ID (optional). Falls back to the server-configured default model when not specified.\nRouting is prefix-based: `claude-*` models route to Anthropic; all other model IDs route to OpenAI.\nExamples: `claude-haiku-4-5-20251001` (Anthropic), `gpt-4.1` (OpenAI).\n","required":false,"schema":{"type":"string","example":"claude-haiku-4-5-20251001","isRequired":false,"description":"LLM model ID (optional). Falls back to the server-configured default model when not specified.\nRouting is prefix-based: `claude-*` models route to Anthropic; all other model IDs route to OpenAI.\nExamples: `claude-haiku-4-5-20251001` (Anthropic), `gpt-4.1` (OpenAI).\n","uniqueKey":"","typeLabel":"string"}},"33dc54e2-aabe-4bb7-8352-8b859d602dbe":{"name":"llm_max_tokens","in":"query","description":"Maximum output tokens for LLM transform (optional). Falls back to the server default when not specified.\n","required":false,"schema":{"type":"integer","minimum":1,"maximum":4096,"example":1024,"isRequired":false,"description":"Maximum output tokens for LLM transform (optional). Falls back to the server default when not specified.\n","uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"audio/wav":{"schema":{"type":"string","format":"binary","uniqueKey":"","typeLabel":"file"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"},"audio/mpeg":{"schema":{"type":"string","format":"binary","uniqueKey":"","typeLabel":"file"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"},"audio/pcm":{"schema":{"type":"string","format":"binary","uniqueKey":"","typeLabel":"file"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"},"application/octet-stream":{"schema":{"type":"string","format":"binary","uniqueKey":"","typeLabel":"file"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8c097229-2cdb-4a5c-91ac-4bc368424943":{"description":"Successfully returns recognition result","headers":{"X-Request-ID":{"schema":{"type":"string"},"description":"Request ID"},"X-Language":{"schema":{"type":"string"},"description":"Detected language code"},"X-Duration-Ms":{"schema":{"type":"integer"},"description":"Audio duration in milliseconds"}},"content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","description":"Request ID","example":"req_1234567890","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"transcript":{"type":"string","description":"Raw STT recognition output (original ASR text before any LLM processing).\nAlways present; identical to `text` when LLM transform is not enabled.\n","example":"Hello this is a test message","isRequired":true,"uniqueKey":"transcript","typeLabel":"string"},"text":{"type":"string","description":"Final output text. When LLM transform is enabled and succeeds, this contains\nthe LLM-transformed result; otherwise it equals `transcript`.\n","example":"Hello, this is a test message.","isRequired":true,"uniqueKey":"text","typeLabel":"string"},"duration_ms":{"type":"integer","description":"Audio duration in milliseconds","example":2500,"isRequired":true,"uniqueKey":"duration_ms","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"Creation time","example":"2024-01-01T12:00:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"language":{"type":"string","description":"Detected language code, e.g. en, en-US","example":"en","uniqueKey":"language","typeLabel":"string"},"words":{"type":"array","description":"Word-level information (if timestamps are enabled)","items":{"type":"object","properties":{"word":{"type":"string","description":"Word","example":"hello","isRequired":true,"uniqueKey":"words.items.[INDEX].word","typeLabel":"string"},"offset":{"type":"integer","description":"Word offset in audio stream (milliseconds)","example":0,"uniqueKey":"words.items.[INDEX].offset","typeLabel":"integer"},"duration":{"type":"integer","description":"Word duration (milliseconds)","example":500,"uniqueKey":"words.items.[INDEX].duration","typeLabel":"integer"},"confidence":{"type":"number","format":"float","description":"Confidence score 0.0-1.0","minimum":0,"maximum":1,"example":0.98,"uniqueKey":"words.items.[INDEX].confidence","typeLabel":"number\u003cfloat>"}},"required":["word"],"uniqueKey":"words.items.[INDEX]","typeLabel":"object"},"uniqueKey":"words","typeLabel":"object[]"},"speakers":{"type":"array","description":"Speaker information (if speaker diarization is enabled)","items":{"type":"object","properties":{"speaker_id":{"type":"string","description":"Speaker ID","example":"speaker_1","isRequired":true,"uniqueKey":"speakers.items.[INDEX].speaker_id","typeLabel":"string"},"text":{"type":"string","description":"Text spoken by this speaker","example":"Hello, this is a test message.","isRequired":true,"uniqueKey":"speakers.items.[INDEX].text","typeLabel":"string"},"offset":{"type":"integer","description":"Speaker text offset in audio stream (milliseconds)","example":0,"uniqueKey":"speakers.items.[INDEX].offset","typeLabel":"integer"},"duration":{"type":"integer","description":"Speaker text duration (milliseconds)","example":2500,"uniqueKey":"speakers.items.[INDEX].duration","typeLabel":"integer"}},"required":["speaker_id","text"],"uniqueKey":"speakers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"speakers","typeLabel":"object[]"}},"required":["request_id","transcript","text","duration_ms","created_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"request_id":"req_1234567890","transcript":"Hello this is a test message","text":"Hello, this is a test message.","duration_ms":2500,"created_at":"2024-01-01T12:00:00Z","language":"en","words":[{"word":"hello","offset":0,"duration":500,"confidence":0.98}],"speakers":[{"speaker_id":"speaker_1","text":"Hello, this is a test message.","offset":0,"duration":2500}]}}},"exampleType":"generated"}},"exampleType":"generated"},"00890c83-f302-4cc0-a059-8fefaae196fe":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code","example":"INVALID_REQUEST","uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","description":"Detailed error information (optional)","example":"Detailed error information","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Request ID (optional)","example":"req_1234567890","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request parameters","code":"INVALID_REQUEST","details":"Detailed error information","request_id":"req_1234567890"}}},"exampleType":"generated"}},"exampleType":"generated"},"6727cc7f-e004-4259-9df9-db183cd3f271":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code","example":"INVALID_REQUEST","uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","description":"Detailed error information (optional)","example":"Detailed error information","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Request ID (optional)","example":"req_1234567890","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request parameters","code":"INVALID_REQUEST","details":"Detailed error information","request_id":"req_1234567890"}}},"exampleType":"generated"}},"exampleType":"generated"},"7e82f815-e1a1-410b-a60b-671f98060547":{"description":"Insufficient credits or rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code","example":"INVALID_REQUEST","uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","description":"Detailed error information (optional)","example":"Detailed error information","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Request ID (optional)","example":"req_1234567890","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request parameters","code":"INVALID_REQUEST","details":"Detailed error information","request_id":"req_1234567890"}}},"exampleType":"generated"}},"exampleType":"generated"},"09b70598-ad9a-46c2-8aa3-e55b4304ec5a":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","example":"Invalid request parameters","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code","example":"INVALID_REQUEST","uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","description":"Detailed error information (optional)","example":"Detailed error information","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Request ID (optional)","example":"req_1234567890","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request parameters","code":"INVALID_REQUEST","details":"Detailed error information","request_id":"req_1234567890"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"996b14fa-47e9-47f2-9c1e-55282105ded4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"Authenticate using X-Api-Key header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"2d9f2c45-633a-41ff-a618-432f00e916ff":{"url":"https://api.voxnexus.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"Authenticate using X-Api-Key header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-Api-Key","type":"string","description":"Authenticate using X-Api-Key header","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-Api-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"senpng","siteName":"VoxNexus","title":"Speech to Text - VoxNexus","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-15T13:31:33.912Z","originalFileLocation":"api-reference/stt/speech-to-text.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Convert audio file to text, returns complete recognition result\">\u003cmeta data-mint-head name=\"application-name\" content=\"VoxNexus\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Speech to Text - VoxNexus\">\u003cmeta data-mint-head property=\"og:description\" content=\"Convert audio file to text, returns complete recognition result\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VoxNexus\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://senpng.mintlify.app/_mintlify/api/og/v2?division=stt\u0026amp;title=Speech+to+Text\u0026amp;description=Convert+audio+file+to+text%2C+returns+complete+recognition+result\u0026amp;theme=46f67f8d929b0b03b8c537b1\u0026amp;signature=b993901a1c81f8396482c1bf19cce6ba06a8d1718e58a034db152fa4fabb9a60\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Speech to Text - VoxNexus\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Convert audio file to text, returns complete recognition result\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://senpng.mintlify.app/_mintlify/api/og/v2?division=stt\u0026amp;title=Speech+to+Text\u0026amp;description=Convert+audio+file+to+text%2C+returns+complete+recognition+result\u0026amp;theme=46f67f8d929b0b03b8c537b1\u0026amp;signature=b993901a1c81f8396482c1bf19cce6ba06a8d1718e58a034db152fa4fabb9a60\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/senpng/xqHBmzF_A1o6PnRK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VoxNexus\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1a365d\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/stt/speech-to-text.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voxnexus.ai/#organization\",\"name\":\"VoxNexus\",\"url\":\"https://docs.voxnexus.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/senpng/3_76exvqAfUXx55L/logo/light.png?fit=max\u0026auto=format\u0026n=3_76exvqAfUXx55L\u0026q=85\u0026s=6dac020b56bdc0d66f570d2576f49c7f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voxnexus.ai#website\",\"name\":\"VoxNexus\",\"url\":\"https://docs.voxnexus.ai\",\"publisher\":{\"@id\":\"https://docs.voxnexus.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text#webpage\",\"url\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text\",\"name\":\"Speech to Text\",\"description\":\"Convert audio file to text, returns complete recognition result\",\"dateModified\":\"2026-10-15T13:31:33.912Z\",\"isPartOf\":{\"@id\":\"https://docs.voxnexus.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.voxnexus.ai/api-reference/text-to-speech/guide\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Speech to Text\",\"item\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text#apireference\",\"headline\":\"Speech to Text\",\"name\":\"Speech to Text\",\"description\":\"Convert audio file to text, returns complete recognition result\",\"url\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voxnexus.ai/api-reference/stt/speech-to-text#webpage\"},\"dateModified\":\"2026-10-15T13:31:33.912Z\",\"publisher\":{\"@id\":\"https://docs.voxnexus.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voxnexus.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VoxNexus\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VoxNexus","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"REST API","pages":[{"title":"Text-to-Speech Guide","href":"/api-reference/text-to-speech/guide"},{"title":"Speech-to-Text Guide","href":"/api-reference/speech-to-text/guide"},{"title":"Translation Guide","href":"/api-reference/translation/guide"},{"title":"Language Codes","href":"/api-reference/translation/languages"},{"group":"tts","pages":[{"title":"Text to Speech","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tts","href":"/api-reference/tts/text-to-speech"},{"group":"tts-intervention","pages":[{"title":"List pronunciation groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tts/intervention/groups","href":"/api-reference/tts-intervention/list-pronunciation-groups"},{"title":"Create a pronunciation group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tts/intervention/groups","href":"/api-reference/tts-intervention/create-a-pronunciation-group"},{"title":"Rename a pronunciation group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/tts/intervention/groups/{group_id}","href":"/api-reference/tts-intervention/rename-a-pronunciation-group"},{"title":"Delete an empty pronunciation group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tts/intervention/groups/{group_id}","href":"/api-reference/tts-intervention/delete-an-empty-pronunciation-group"},{"title":"List user pronunciation rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tts/intervention/entries","href":"/api-reference/tts-intervention/list-user-pronunciation-rules"},{"title":"Create a pronunciation rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tts/intervention/entries","href":"/api-reference/tts-intervention/create-a-pronunciation-rule"},{"title":"Update a pronunciation rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/tts/intervention/entries/{entry_id}","href":"/api-reference/tts-intervention/update-a-pronunciation-rule"},{"title":"Delete a pronunciation rule","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tts/intervention/entries/{entry_id}","href":"/api-reference/tts-intervention/delete-a-pronunciation-rule"}]}]},{"group":"stt","pages":[{"title":"Speech to Text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/stt","href":"/api-reference/stt/speech-to-text"}]},{"group":"voices","pages":[{"title":"List Voices","description":"Get available voice list, supports filtering by language, gender, style, etc.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/voices","href":"/api-reference/voices/list-voices"},{"title":"Get Voice Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/voices/{voice_id}","href":"/api-reference/voices/get-voice-details"},{"title":"Search Voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/voices/search","href":"/api-reference/voices/search-voices"}]},{"group":"models","pages":[{"title":"List Models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/models","href":"/api-reference/models/list-models"},{"title":"Get Model Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/models/{model_id}","href":"/api-reference/models/get-model-details"}]},{"group":"translate","pages":[{"title":"Translate Text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/translate","href":"/api-reference/translate/translate-text"}]}]},{"group":"WebSocket API","pages":[{"title":"WebSocket API Guide","href":"/api-reference/websocket/guide"},{"group":"Websockets","pages":[{"asyncapi":"api-reference/asyncapi.yaml ttsRealtime","href":"/api-reference/websockets/tts-realtime","title":"TTS Realtime","version":null},{"asyncapi":"api-reference/asyncapi.yaml sttRealtime","href":"/api-reference/websockets/stt-realtime","title":"STT Realtime","version":null},{"asyncapi":"api-reference/asyncapi.yaml translateRealtime","href":"/api-reference/websockets/translate-realtime","title":"Translate Realtime","version":null}]}]}]}]},"title":"Speech to Text - VoxNexus","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}