# Generate the key once; reuse it and the same body if the response is lost.IDEMPOTENCY_KEY=$(python -c 'import uuid; print(uuid.uuid4())')curl --request POST \ --url https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions \ --header "accessKey: $MYVOCAL_ACCESS_KEY" \ --header "Idempotency-Key: $IDEMPOTENCY_KEY" \ --header 'Content-Type: application/json' \ --data '{"languageHint":"en","options":{"inputEncoding":"pcm_s16le_16000","segmentCommitMode":"manual"}}'
Start a streaming transcription session and get its socket URL.
POST
/
sound_clone
/
api
/
v1
/
stt
/
realtime
/
sessions
# Generate the key once; reuse it and the same body if the response is lost.IDEMPOTENCY_KEY=$(python -c 'import uuid; print(uuid.uuid4())')curl --request POST \ --url https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions \ --header "accessKey: $MYVOCAL_ACCESS_KEY" \ --header "Idempotency-Key: $IDEMPOTENCY_KEY" \ --header 'Content-Type: application/json' \ --data '{"languageHint":"en","options":{"inputEncoding":"pcm_s16le_16000","segmentCommitMode":"manual"}}'
Speech to Text · Real-time · Workflow: Real-time quickstart · Real-time SDKsCreates a real-time session. Audio is then streamed over the returned streamUrl. The session shares
History and the Characters balance with Batch.
# Generate the key once; reuse it and the same body if the response is lost.IDEMPOTENCY_KEY=$(python -c 'import uuid; print(uuid.uuid4())')curl --request POST \ --url https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions \ --header "accessKey: $MYVOCAL_ACCESS_KEY" \ --header "Idempotency-Key: $IDEMPOTENCY_KEY" \ --header 'Content-Type: application/json' \ --data '{"languageHint":"en","options":{"inputEncoding":"pcm_s16le_16000","segmentCommitMode":"manual"}}'
Binds this request. The same key and the same body (including title and options) return the same
session; a changed title or option under the same key is IDEMPOTENCY_CONFLICT.
Body
string
The spoken language, or omit for automatic detection.
string
A title for the History row, up to 200 characters. Defaults to a generic recording title.
object
Optional processing controls.
Hide properties
string
default:"pcm_s16le_16000"
The byte format you will send: pcm_s16le_8000, pcm_s16le_16000, pcm_s16le_22050,
pcm_s16le_24000, pcm_s16le_44100, pcm_s16le_48000 or mulaw_8000. PCM is signed 16-bit
little-endian mono; μ-law is one byte per sample. The chosen rate drives the whole session timeline.
string
default:"manual"
manual (you commit segments) or vad (the model decides segment boundaries).
string[]
Candidate language hints, up to 8. This is not the detected language.
number
Speech threshold for vad, between 0 and 1.
number
Silence before a vad commit, from 0 to 60000 milliseconds.
number
Minimum speech length, an integer from 0 to 60000 milliseconds.
number
Minimum silence length, an integer from 0 to 60000 milliseconds.
boolean
Word and character alignment. Mutually exclusive with options.suppressBackgroundSpeech; when
background filtering is on and this is unset, alignment defaults to off.
boolean
Return the detected language.
string[]
Key terms to bias recognition, up to 50 entries.
boolean
Remove filler words.
string[]
Detect entities of these categories. Mutually exclusive with options.rewriteInstruction.
string
Instruction for an edited transcript, up to 2000 characters. Mutually exclusive with
options.entityCategories.
boolean
Filter background speech. Mutually exclusive with timestamps.
number
Processing connection keepalive interval between 500 and 10000 milliseconds. This is not
a client-to-MyVocal socket heartbeat; see connection guidance.
boolean
Request processing-side content storage. Account eligibility is not verified; if the model returns
a warning that it was not applied, the session reports a
PROCESSING_STORAGE_NOT_APPLIED notice. Neither acceptance nor absence of a notice guarantees
zero retention; see current limitations.
Response
Successful REST calls return { code: 1, message, data }. The fields below are inside data;
JSON downloads are the documented exception and return the transcript view directly.
number
1 for success.
string
Result message.
object
Hide properties
string
The session id (rts_...).
string
The History id (stt_...), the same entity Batch results use.
string
The session state: RECORDING, PAUSED or CLOSED, or the task status once closed.
string
myvocal_stt_realtime_v1.
string
The MyVocal socket path. Connect it as a WebSocket; identity comes from the accessKey header or a
ticket, never from the URL string alone.
object
The options in effect, including the resolved inputEncoding and sampleRateHz.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"MyVocal.AI","colors":{"primary":"#9563FF","light":"#AE87FF","dark":"#0D001D"},"favicon":"https://mintcdn.com/wiz-myvocal/kDrQNVoFkA5WOhL_/favicon.svg?fit=max\u0026auto=format\u0026n=kDrQNVoFkA5WOhL_\u0026q=85\u0026s=b815e0db5883be2f70d9b10e63c330cd","logo":{"light":"https://mintcdn.com/wiz-myvocal/kDrQNVoFkA5WOhL_/logo/light.svg?fit=max\u0026auto=format\u0026n=kDrQNVoFkA5WOhL_\u0026q=85\u0026s=1d17c658234c347ae43c180de792bea5","dark":"https://mintcdn.com/wiz-myvocal/kDrQNVoFkA5WOhL_/logo/dark.png?fit=max\u0026auto=format\u0026n=kDrQNVoFkA5WOhL_\u0026q=85\u0026s=3d789334f44d9a10eaf0dbd26dadfaa3"},"background":{"decoration":null,"color":{"light":null,"dark":"#090014"}},"navbar":{"links":[{"label":"API Reference","href":"/api-reference/overview"}],"primary":{"type":"button","label":"Home Page","href":"https://www.myvocal.ai"}},"seo":{"metatags":{"canonical":"https://docs.myvocal.ai"},"indexing":"navigable"},"footer":{"socials":{"youtube":"https://www.youtube.com/@myvocalai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wiz-myvocal","hasAudioNarration":false,"actualSubdomain":"wiz-myvocal","customDomains":[],"gitSource":{"type":"github","owner":"myvocal-ai","repo":"api","deployBranch":"main","contentDirectory":"myvocal-api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af0789710764caba8e8690e","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Speech to Text","count":24},{"language":"default","tag":"Interpretation","count":23},{"language":"default","tag":"Interpretation API reference","count":20},{"language":"default","tag":"Text to Music","count":16},{"language":"default","tag":"STT API reference","count":16},{"language":"default","tag":"Music API reference","count":15},{"language":"default","tag":"Create and generate","count":10},{"language":"default","tag":"Text to Speech","count":9},{"language":"default","tag":"Manage projects","count":9},{"language":"default","tag":"Voice cloning","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/stt/createSession","slug":"/api-reference/stt/createSession","pageMetadata":{"title":"Create a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions","description":"Start a streaming transcription session and get its socket URL.","href":"/api-reference/stt/createSession"},"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: \"Start a streaming transcription session and get its socket URL.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(`sub`,{children:[_jsx(_components.strong,{children:`Speech to Text · Real-time`}),` · Workflow: `,_jsx(_components.a,{href:`/guides/stt-realtime-quickstart`,children:`Real-time quickstart`}),` · `,_jsx(_components.a,{href:`/sdks/stt-realtime/overview`,children:`Real-time SDKs`})]}),`\n`,_jsxs(_components.p,{children:[`Creates a real-time session. Audio is then streamed over the returned `,_jsx(_components.code,{children:`streamUrl`}),`. The session shares\nHistory and the Characters balance with Batch.`]}),`\n`,`\n`,`\n`,_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{header:`accessKey`,type:`string`,required:true,id:`param-access-key`,children:_jsxs(_components.p,{children:[`Your API key. See `,_jsx(_components.a,{href:`/api-reference/authentication`,children:`Authentication`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Idempotency-Key`,type:`string`,required:true,id:`param-idempotency-key`,children:_jsxs(_components.p,{children:[`Binds this request. The same key and the same body (including `,_jsx(_components.code,{children:`title`}),` and `,_jsx(_components.code,{children:`options`}),`) return the same\nsession; a changed title or option under the same key is `,_jsx(_components.code,{children:`IDEMPOTENCY_CONFLICT`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`languageHint`,type:`string`,id:`param-language-hint`,children:_jsx(_components.p,{children:`The spoken language, or omit for automatic detection.`})}),`\n`,_jsx(ParamField,{body:`title`,type:`string`,id:`param-title`,children:_jsx(_components.p,{children:`A title for the History row, up to 200 characters. Defaults to a generic recording title.`})}),`\n`,_jsxs(ParamField,{body:`options`,type:`object`,id:`param-options`,children:[_jsx(_components.p,{children:`Optional processing controls.`}),_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ParamField,{body:`inputEncoding`,type:`string`,default:`pcm_s16le_16000`,id:`param-input-encoding`,children:_jsxs(_components.p,{children:[`The byte format you will send: `,_jsx(_components.code,{children:`pcm_s16le_8000`}),`, `,_jsx(_components.code,{children:`pcm_s16le_16000`}),`, `,_jsx(_components.code,{children:`pcm_s16le_22050`}),`,\n`,_jsx(_components.code,{children:`pcm_s16le_24000`}),`, `,_jsx(_components.code,{children:`pcm_s16le_44100`}),`, `,_jsx(_components.code,{children:`pcm_s16le_48000`}),` or `,_jsx(_components.code,{children:`mulaw_8000`}),`. PCM is signed 16-bit\nlittle-endian mono; μ-law is one byte per sample. The chosen rate drives the whole session timeline.`]})}),_jsx(ParamField,{body:`segmentCommitMode`,type:`string`,default:`manual`,id:`param-segment-commit-mode`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`manual`}),` (you commit segments) or `,_jsx(_components.code,{children:`vad`}),` (the model decides segment boundaries).`]})}),_jsx(ParamField,{body:`additionalLanguageHints`,type:`string[]`,id:`param-additional-language-hints`,children:_jsx(_components.p,{children:`Candidate language hints, up to 8. This is not the detected language.`})}),_jsx(ParamField,{body:`speechDetectionThreshold`,type:`number`,id:`param-speech-detection-threshold`,children:_jsxs(_components.p,{children:[`Speech threshold for `,_jsx(_components.code,{children:`vad`}),`, between `,_jsx(_components.code,{children:`0`}),` and `,_jsx(_components.code,{children:`1`}),`.`]})}),_jsx(ParamField,{body:`commitSilenceMs`,type:`number`,id:`param-commit-silence-ms`,children:_jsxs(_components.p,{children:[`Silence before a `,_jsx(_components.code,{children:`vad`}),` commit, from 0 to 60000 milliseconds.`]})}),_jsx(ParamField,{body:`minimumSpeechMs`,type:`number`,id:`param-minimum-speech-ms`,children:_jsx(_components.p,{children:`Minimum speech length, an integer from 0 to 60000 milliseconds.`})}),_jsx(ParamField,{body:`minimumSilenceMs`,type:`number`,id:`param-minimum-silence-ms`,children:_jsx(_components.p,{children:`Minimum silence length, an integer from 0 to 60000 milliseconds.`})}),_jsx(ParamField,{body:`includeAlignment`,type:`boolean`,id:`param-include-alignment`,children:_jsxs(_components.p,{children:[`Word and character alignment. Mutually exclusive with `,_jsx(_components.code,{children:`options.suppressBackgroundSpeech`}),`; when\nbackground filtering is on and this is unset, alignment defaults to off.`]})}),_jsx(ParamField,{body:`includeDetectedLanguage`,type:`boolean`,id:`param-include-detected-language`,children:_jsx(_components.p,{children:`Return the detected language.`})}),_jsx(ParamField,{body:`vocabularyHints`,type:`string[]`,id:`param-vocabulary-hints`,children:_jsx(_components.p,{children:`Key terms to bias recognition, up to 50 entries.`})}),_jsx(ParamField,{body:`removeDisfluencies`,type:`boolean`,id:`param-remove-disfluencies`,children:_jsx(_components.p,{children:`Remove filler words.`})}),_jsx(ParamField,{body:`entityCategories`,type:`string[]`,id:`param-entity-categories`,children:_jsxs(_components.p,{children:[`Detect entities of these categories. Mutually exclusive with `,_jsx(_components.code,{children:`options.rewriteInstruction`}),`.`]})}),_jsx(ParamField,{body:`rewriteInstruction`,type:`string`,id:`param-rewrite-instruction`,children:_jsxs(_components.p,{children:[`Instruction for an edited transcript, up to 2000 characters. Mutually exclusive with\n`,_jsx(_components.code,{children:`options.entityCategories`}),`.`]})}),_jsx(ParamField,{body:`suppressBackgroundSpeech`,type:`boolean`,id:`param-suppress-background-speech`,children:_jsx(_components.p,{children:`Filter background speech. Mutually exclusive with timestamps.`})}),_jsx(ParamField,{body:`heartbeatIntervalMs`,type:`number`,id:`param-heartbeat-interval-ms`,children:_jsxs(_components.p,{children:[`Processing connection keepalive interval between `,_jsx(_components.code,{children:`500`}),` and `,_jsx(_components.code,{children:`10000`}),` milliseconds. This is not\na client-to-MyVocal socket heartbeat; see `,_jsx(_components.a,{href:`/guides/stt-realtime-quickstart#6-rotation-recovery-and-errors`,children:`connection guidance`}),`.`]})}),_jsx(ParamField,{body:`processingContentStorage`,type:`boolean`,id:`param-processing-content-storage`,children:_jsxs(_components.p,{children:[`Request processing-side content storage. Account eligibility is not verified; if the model returns\na warning that it was not applied, the session reports a\n`,_jsx(_components.code,{children:`PROCESSING_STORAGE_NOT_APPLIED`}),` notice. Neither acceptance nor absence of a notice guarantees\nzero retention; see `,_jsx(_components.a,{href:`/guides/stt-availability`,children:`current limitations`}),`.`]})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Successful REST calls return `,_jsx(_components.code,{children:`{ code: 1, message, data }`}),`. The fields below are inside `,_jsx(_components.code,{children:`data`}),`;\nJSON downloads are the documented exception and return the transcript view directly.`]}),`\n`,_jsxs(ResponseField,{name:`code`,type:`number`,id:`param-code`,children:[_jsx(_components.code,{children:`1`}),` for success.`]}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:`Result message.`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ResponseField,{name:`sessionId`,type:`string`,id:`param-session-id`,children:_jsxs(_components.p,{children:[`The session id (`,_jsx(_components.code,{children:`rts_...`}),`).`]})}),_jsx(ResponseField,{name:`transcriptionId`,type:`string`,id:`param-transcription-id`,children:_jsxs(_components.p,{children:[`The History id (`,_jsx(_components.code,{children:`stt_...`}),`), the same entity Batch results use.`]})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`The session state: `,_jsx(_components.code,{children:`RECORDING`}),`, `,_jsx(_components.code,{children:`PAUSED`}),` or `,_jsx(_components.code,{children:`CLOSED`}),`, or the task status once closed.`]})}),_jsx(ResponseField,{name:`modelId`,type:`string`,id:`param-model-id`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`myvocal_stt_realtime_v1`}),`.`]})}),_jsx(ResponseField,{name:`streamUrl`,type:`string`,id:`param-stream-url`,children:_jsxs(_components.p,{children:[`The MyVocal socket path. Connect it as a WebSocket; identity comes from the `,_jsx(_components.code,{children:`accessKey`}),` header or a\nticket, never from the URL string alone.`]})}),_jsx(ResponseField,{name:`effectiveOptions`,type:`object`,id:`param-effective-options`,children:_jsxs(_components.p,{children:[`The options in effect, including the resolved `,_jsx(_components.code,{children:`inputEncoding`}),` and `,_jsx(_components.code,{children:`sampleRateHz`}),`.`]})})]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions","description":"Start a streaming transcription session and get its socket URL.","href":"/api-reference/stt/createSession"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(`sub`,{children:[_jsx(_components.strong,{children:`Speech to Text · Real-time`}),` · Workflow: `,_jsx(_components.a,{href:`/guides/stt-realtime-quickstart`,children:`Real-time quickstart`}),` · `,_jsx(_components.a,{href:`/sdks/stt-realtime/overview`,children:`Real-time SDKs`})]}),`\n`,_jsxs(_components.p,{children:[`Creates a real-time session. Audio is then streamed over the returned `,_jsx(_components.code,{children:`streamUrl`}),`. The session shares\nHistory and the Characters balance with Batch.`]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Generate the key once; reuse it and the same body if the response is lost.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`IDEMPOTENCY_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`$(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'import uuid; print(uuid.uuid4())'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"accessKey: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$MYVOCAL_ACCESS_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Idempotency-Key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$IDEMPOTENCY_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"languageHint\":\"en\",\"options\":{\"inputEncoding\":\"pcm_s16le_16000\",\"segmentCommitMode\":\"manual\"}}'`})]}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`200`,numberOfLines:`12`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sessionId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003csessionId>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"transcriptionId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003ctranscriptionId>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"RECORDING\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"modelId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"myvocal_stt_realtime_v1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"streamUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003creturned socket path>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"effectiveOptions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"inputEncoding\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pcm_s16le_16000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"sampleRateHz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`16000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{header:`accessKey`,type:`string`,required:true,id:`param-access-key`,children:_jsxs(_components.p,{children:[`Your API key. See `,_jsx(_components.a,{href:`/api-reference/authentication`,children:`Authentication`}),`.`]})}),`\n`,_jsx(ParamField,{header:`Idempotency-Key`,type:`string`,required:true,id:`param-idempotency-key`,children:_jsxs(_components.p,{children:[`Binds this request. The same key and the same body (including `,_jsx(_components.code,{children:`title`}),` and `,_jsx(_components.code,{children:`options`}),`) return the same\nsession; a changed title or option under the same key is `,_jsx(_components.code,{children:`IDEMPOTENCY_CONFLICT`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`languageHint`,type:`string`,id:`param-language-hint`,children:_jsx(_components.p,{children:`The spoken language, or omit for automatic detection.`})}),`\n`,_jsx(ParamField,{body:`title`,type:`string`,id:`param-title`,children:_jsx(_components.p,{children:`A title for the History row, up to 200 characters. Defaults to a generic recording title.`})}),`\n`,_jsxs(ParamField,{body:`options`,type:`object`,id:`param-options`,children:[_jsx(_components.p,{children:`Optional processing controls.`}),_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ParamField,{body:`inputEncoding`,type:`string`,default:`pcm_s16le_16000`,id:`param-input-encoding`,children:_jsxs(_components.p,{children:[`The byte format you will send: `,_jsx(_components.code,{children:`pcm_s16le_8000`}),`, `,_jsx(_components.code,{children:`pcm_s16le_16000`}),`, `,_jsx(_components.code,{children:`pcm_s16le_22050`}),`,\n`,_jsx(_components.code,{children:`pcm_s16le_24000`}),`, `,_jsx(_components.code,{children:`pcm_s16le_44100`}),`, `,_jsx(_components.code,{children:`pcm_s16le_48000`}),` or `,_jsx(_components.code,{children:`mulaw_8000`}),`. PCM is signed 16-bit\nlittle-endian mono; μ-law is one byte per sample. The chosen rate drives the whole session timeline.`]})}),_jsx(ParamField,{body:`segmentCommitMode`,type:`string`,default:`manual`,id:`param-segment-commit-mode`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`manual`}),` (you commit segments) or `,_jsx(_components.code,{children:`vad`}),` (the model decides segment boundaries).`]})}),_jsx(ParamField,{body:`additionalLanguageHints`,type:`string[]`,id:`param-additional-language-hints`,children:_jsx(_components.p,{children:`Candidate language hints, up to 8. This is not the detected language.`})}),_jsx(ParamField,{body:`speechDetectionThreshold`,type:`number`,id:`param-speech-detection-threshold`,children:_jsxs(_components.p,{children:[`Speech threshold for `,_jsx(_components.code,{children:`vad`}),`, between `,_jsx(_components.code,{children:`0`}),` and `,_jsx(_components.code,{children:`1`}),`.`]})}),_jsx(ParamField,{body:`commitSilenceMs`,type:`number`,id:`param-commit-silence-ms`,children:_jsxs(_components.p,{children:[`Silence before a `,_jsx(_components.code,{children:`vad`}),` commit, from 0 to 60000 milliseconds.`]})}),_jsx(ParamField,{body:`minimumSpeechMs`,type:`number`,id:`param-minimum-speech-ms`,children:_jsx(_components.p,{children:`Minimum speech length, an integer from 0 to 60000 milliseconds.`})}),_jsx(ParamField,{body:`minimumSilenceMs`,type:`number`,id:`param-minimum-silence-ms`,children:_jsx(_components.p,{children:`Minimum silence length, an integer from 0 to 60000 milliseconds.`})}),_jsx(ParamField,{body:`includeAlignment`,type:`boolean`,id:`param-include-alignment`,children:_jsxs(_components.p,{children:[`Word and character alignment. Mutually exclusive with `,_jsx(_components.code,{children:`options.suppressBackgroundSpeech`}),`; when\nbackground filtering is on and this is unset, alignment defaults to off.`]})}),_jsx(ParamField,{body:`includeDetectedLanguage`,type:`boolean`,id:`param-include-detected-language`,children:_jsx(_components.p,{children:`Return the detected language.`})}),_jsx(ParamField,{body:`vocabularyHints`,type:`string[]`,id:`param-vocabulary-hints`,children:_jsx(_components.p,{children:`Key terms to bias recognition, up to 50 entries.`})}),_jsx(ParamField,{body:`removeDisfluencies`,type:`boolean`,id:`param-remove-disfluencies`,children:_jsx(_components.p,{children:`Remove filler words.`})}),_jsx(ParamField,{body:`entityCategories`,type:`string[]`,id:`param-entity-categories`,children:_jsxs(_components.p,{children:[`Detect entities of these categories. Mutually exclusive with `,_jsx(_components.code,{children:`options.rewriteInstruction`}),`.`]})}),_jsx(ParamField,{body:`rewriteInstruction`,type:`string`,id:`param-rewrite-instruction`,children:_jsxs(_components.p,{children:[`Instruction for an edited transcript, up to 2000 characters. Mutually exclusive with\n`,_jsx(_components.code,{children:`options.entityCategories`}),`.`]})}),_jsx(ParamField,{body:`suppressBackgroundSpeech`,type:`boolean`,id:`param-suppress-background-speech`,children:_jsx(_components.p,{children:`Filter background speech. Mutually exclusive with timestamps.`})}),_jsx(ParamField,{body:`heartbeatIntervalMs`,type:`number`,id:`param-heartbeat-interval-ms`,children:_jsxs(_components.p,{children:[`Processing connection keepalive interval between `,_jsx(_components.code,{children:`500`}),` and `,_jsx(_components.code,{children:`10000`}),` milliseconds. This is not\na client-to-MyVocal socket heartbeat; see `,_jsx(_components.a,{href:`/guides/stt-realtime-quickstart#6-rotation-recovery-and-errors`,children:`connection guidance`}),`.`]})}),_jsx(ParamField,{body:`processingContentStorage`,type:`boolean`,id:`param-processing-content-storage`,children:_jsxs(_components.p,{children:[`Request processing-side content storage. Account eligibility is not verified; if the model returns\na warning that it was not applied, the session reports a\n`,_jsx(_components.code,{children:`PROCESSING_STORAGE_NOT_APPLIED`}),` notice. Neither acceptance nor absence of a notice guarantees\nzero retention; see `,_jsx(_components.a,{href:`/guides/stt-availability`,children:`current limitations`}),`.`]})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Successful REST calls return `,_jsx(_components.code,{children:`{ code: 1, message, data }`}),`. The fields below are inside `,_jsx(_components.code,{children:`data`}),`;\nJSON downloads are the documented exception and return the transcript view directly.`]}),`\n`,_jsxs(ResponseField,{name:`code`,type:`number`,id:`param-code`,children:[_jsx(_components.code,{children:`1`}),` for success.`]}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:`Result message.`}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`properties`,defaultOpen:true,children:[_jsx(ResponseField,{name:`sessionId`,type:`string`,id:`param-session-id`,children:_jsxs(_components.p,{children:[`The session id (`,_jsx(_components.code,{children:`rts_...`}),`).`]})}),_jsx(ResponseField,{name:`transcriptionId`,type:`string`,id:`param-transcription-id`,children:_jsxs(_components.p,{children:[`The History id (`,_jsx(_components.code,{children:`stt_...`}),`), the same entity Batch results use.`]})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`The session state: `,_jsx(_components.code,{children:`RECORDING`}),`, `,_jsx(_components.code,{children:`PAUSED`}),` or `,_jsx(_components.code,{children:`CLOSED`}),`, or the task status once closed.`]})}),_jsx(ResponseField,{name:`modelId`,type:`string`,id:`param-model-id`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`myvocal_stt_realtime_v1`}),`.`]})}),_jsx(ResponseField,{name:`streamUrl`,type:`string`,id:`param-stream-url`,children:_jsxs(_components.p,{children:[`The MyVocal socket path. Connect it as a WebSocket; identity comes from the `,_jsx(_components.code,{children:`accessKey`}),` header or a\nticket, never from the URL string alone.`]})}),_jsx(ResponseField,{name:`effectiveOptions`,type:`object`,id:`param-effective-options`,children:_jsxs(_components.p,{children:[`The options in effect, including the resolved `,_jsx(_components.code,{children:`inputEncoding`}),` and `,_jsx(_components.code,{children:`sampleRateHz`}),`.`]})})]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions","description":"Start a streaming transcription session and get its socket URL.","href":"/api-reference/stt/createSession"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Header","slug":"header","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"8\">\u003cspan class=\"line\">\u003cspan style=\"color:#6E7781;--shiki-dark:#6A9955\"># Generate the key once; reuse it and the same body if the response is lost.\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">IDEMPOTENCY_KEY\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">$(\u003c/span>\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">python\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -c\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'import uuid; print(uuid.uuid4())'\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"accessKey: \u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$MYVOCAL_ACCESS_KEY\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Idempotency-Key: \u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$IDEMPOTENCY_KEY\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\"languageHint\":\"en\",\"options\":{\"inputEncoding\":\"pcm_s16le_16000\",\"segmentCommitMode\":\"manual\"}}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"200","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"12\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"sessionId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u0026#x3C;sessionId>\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"transcriptionId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u0026#x3C;transcriptionId>\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"RECORDING\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"modelId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"myvocal_stt_realtime_v1\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"streamUrl\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u0026#x3C;returned socket path>\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"effectiveOptions\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"inputEncoding\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pcm_s16le_16000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"sampleRateHz\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">:\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">16000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create a real-time session","path":"/sound_clone/api/v1/stt/realtime/sessions","servers":[{"url":"https://api.myvocal.ai"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{"accessKey":{"schema":[{"type":"string","description":"Your API key. See Authentication .","required":true}]},"Idempotency-Key":{"schema":[{"type":"string","description":"Binds this request. The same key and the same body (including `title` and `options` ) return the same session; a changed title or option under the same key is `IDEMPOTENCY_CONFLICT` .","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"languageHint":[{"type":"string","description":"The spoken language, or omit for automatic detection."}],"title":[{"type":"string","description":"A title for the History row, up to 200 characters. Defaults to a generic recording title."}],"options":[{"type":"object","properties":{"inputEncoding":[{"type":"string","description":"The byte format you will send: `pcm_s16le_8000` , `pcm_s16le_16000` , `pcm_s16le_22050` , `pcm_s16le_24000` , `pcm_s16le_44100` , `pcm_s16le_48000` or `mulaw_8000` . PCM is signed 16-bit little-endian mono; μ-law is one byte per sample. The chosen rate drives the whole session timeline."}],"segmentCommitMode":[{"type":"string","description":"`manual` (you commit segments) or `vad` (the model decides segment boundaries)."}],"additionalLanguageHints":[{"type":"array","items":[{"type":"string"}],"description":"Candidate language hints, up to 8. This is not the detected language."}],"speechDetectionThreshold":[{"type":"number","description":"Speech threshold for `vad` , between `0` and `1` ."}],"commitSilenceMs":[{"type":"number","description":"Silence before a `vad` commit, from 0 to 60000 milliseconds."}],"minimumSpeechMs":[{"type":"number","description":"Minimum speech length, an integer from 0 to 60000 milliseconds."}],"minimumSilenceMs":[{"type":"number","description":"Minimum silence length, an integer from 0 to 60000 milliseconds."}],"includeAlignment":[{"type":"boolean","description":"Word and character alignment. Mutually exclusive with `options.suppressBackgroundSpeech` ; when background filtering is on and this is unset, alignment defaults to off."}],"includeDetectedLanguage":[{"type":"boolean","description":"Return the detected language."}],"vocabularyHints":[{"type":"array","items":[{"type":"string"}],"description":"Key terms to bias recognition, up to 50 entries."}],"removeDisfluencies":[{"type":"boolean","description":"Remove filler words."}],"entityCategories":[{"type":"array","items":[{"type":"string"}],"description":"Detect entities of these categories. Mutually exclusive with `options.rewriteInstruction` ."}],"rewriteInstruction":[{"type":"string","description":"Instruction for an edited transcript, up to 2000 characters. Mutually exclusive with `options.entityCategories` ."}],"suppressBackgroundSpeech":[{"type":"boolean","description":"Filter background speech. Mutually exclusive with timestamps."}],"heartbeatIntervalMs":[{"type":"number","description":"Processing connection keepalive interval between `500` and `10000` milliseconds. This is not a client-to-MyVocal socket heartbeat; see connection guidance ."}],"processingContentStorage":[{"type":"boolean","description":"Request processing-side content storage. Account eligibility is not verified; if the model returns a warning that it was not applied, the session reports a `PROCESSING_STORAGE_NOT_APPLIED` notice. Neither acceptance nor absence of a notice guarantees zero retention; see current limitations ."}]},"description":"Optional processing controls."}]}}],"examples":{"example":{"value":{"languageHint":"\u003cstring>","title":"\u003cstring>","options":{"inputEncoding":"\u003cstring>","segmentCommitMode":"\u003cstring>","additionalLanguageHints":["\u003cstring>"],"speechDetectionThreshold":123,"commitSilenceMs":123,"minimumSpeechMs":123,"minimumSilenceMs":123,"includeAlignment":true,"includeDetectedLanguage":true,"vocabularyHints":["\u003cstring>"],"removeDisfluencies":true,"entityCategories":["\u003cstring>"],"rewriteInstruction":"\u003cstring>","suppressBackgroundSpeech":true,"heartbeatIntervalMs":123,"processingContentStorage":true}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"code":[{"type":"number","description":"`1` for success."}],"message":[{"type":"string","description":"Result message."}],"data":[{"type":"object","properties":{"sessionId":[{"type":"string","description":"The session id ( `rts_...` )."}],"transcriptionId":[{"type":"string","description":"The History id ( `stt_...` ), the same entity Batch results use."}],"status":[{"type":"string","description":"The session state: `RECORDING` , `PAUSED` or `CLOSED` , or the task status once closed."}],"modelId":[{"type":"string","description":"`myvocal_stt_realtime_v1` ."}],"streamUrl":[{"type":"string","description":"The MyVocal socket path. Connect it as a WebSocket; identity comes from the `accessKey` header or a ticket, never from the URL string alone."}],"effectiveOptions":[{"type":"object","properties":{},"description":"The options in effect, including the resolved `inputEncoding` and `sampleRateHz` ."}]}}]}}],"examples":{"example":{"value":{"code":123,"message":"\u003cstring>","data":{"sessionId":"\u003cstring>","transcriptionId":"\u003cstring>","status":"\u003cstring>","modelId":"\u003cstring>","streamUrl":"\u003cstring>","effectiveOptions":{}}}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/wiz-myvocal/72f7122fda9600c0/examples/stt/browser/app.js","/_mintlify/custom/wiz-myvocal/596f5e16eb824fa7/examples/stt/browser/capture-worklet.js"],"subdomain":"wiz-myvocal","siteName":"MyVocal.AI","title":"Create a real-time session - MyVocal.AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-06T08:15:08.519Z","originalFileLocation":"api-reference/stt/createSession.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=\"Start a streaming transcription session and get its socket URL.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MyVocal.AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_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/wiz-myvocal/PMBy2yredCIOMzBC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a real-time session - MyVocal.AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start a streaming transcription session and get its socket URL.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MyVocal.AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.myvocal.ai/api-reference/stt/createSession\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wiz-myvocal.mintlify.site/_mintlify/api/og/v2?division=Real-time+sessions\u0026amp;title=Create+a+real-time+session\u0026amp;description=Start+a+streaming+transcription+session+and+get+its+socket+URL.\u0026amp;theme=51bc2ce664bbf25c5bb548d2\u0026amp;signature=8b1cf0b721f364208bf68db854322dad6863634ca5aa12236a1a77beb14f74b3\">\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=\"Create a real-time session - MyVocal.AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start a streaming transcription session and get its socket URL.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wiz-myvocal.mintlify.site/_mintlify/api/og/v2?division=Real-time+sessions\u0026amp;title=Create+a+real-time+session\u0026amp;description=Start+a+streaming+transcription+session+and+get+its+socket+URL.\u0026amp;theme=51bc2ce664bbf25c5bb548d2\u0026amp;signature=8b1cf0b721f364208bf68db854322dad6863634ca5aa12236a1a77beb14f74b3\">\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/wiz-myvocal/PMBy2yredCIOMzBC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MyVocal.AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9563FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.myvocal.ai/api-reference/stt/createSession\">\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/createSession.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.myvocal.ai/#organization\",\"name\":\"MyVocal.AI\",\"url\":\"https://docs.myvocal.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wiz-myvocal/kDrQNVoFkA5WOhL_/logo/light.svg?fit=max\u0026auto=format\u0026n=kDrQNVoFkA5WOhL_\u0026q=85\u0026s=1d17c658234c347ae43c180de792bea5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.myvocal.ai#website\",\"name\":\"MyVocal.AI\",\"url\":\"https://docs.myvocal.ai\",\"publisher\":{\"@id\":\"https://docs.myvocal.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.myvocal.ai/api-reference/stt/createSession#webpage\",\"url\":\"https://docs.myvocal.ai/api-reference/stt/createSession\",\"name\":\"Create a real-time session\",\"description\":\"Start a streaming transcription session and get its socket URL.\",\"dateModified\":\"2026-10-06T08:15:08.519Z\",\"isPartOf\":{\"@id\":\"https://docs.myvocal.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.myvocal.ai/api-reference/stt/createSession#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.myvocal.ai/api-reference/stt/createSession#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Speech to Text\",\"item\":\"https://docs.myvocal.ai/guides/stt-batch-quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"STT API reference\",\"item\":\"https://docs.myvocal.ai/api-reference/stt/capabilities\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a real-time session\",\"item\":\"https://docs.myvocal.ai/api-reference/stt/createSession\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.myvocal.ai/api-reference/stt/createSession#apireference\",\"headline\":\"Create a real-time session\",\"name\":\"Create a real-time session\",\"description\":\"Start a streaming transcription session and get its socket URL.\",\"url\":\"https://docs.myvocal.ai/api-reference/stt/createSession\",\"mainEntityOfPage\":{\"@id\":\"https://docs.myvocal.ai/api-reference/stt/createSession#webpage\"},\"dateModified\":\"2026-10-06T08:15:08.519Z\",\"publisher\":{\"@id\":\"https://docs.myvocal.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.myvocal.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MyVocal.AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"MyVocal.AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/stt/createSession.md","siteName":"MyVocal.AI","nav":{"global":null,"groups":[{"group":"Getting started","pages":[{"title":"MyVocal API","sidebarTitle":"Product overview","href":"/introduction"},{"title":"Make your first API request","sidebarTitle":"First API request","href":"/guides/get-started"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Get account information","sidebarTitle":"Account information","api":"GET https://api.myvocal.ai/sound_clone/api/v1/user/info","href":"/api-reference/user/getInfo"},{"title":"API directory","sidebarTitle":"API directory","href":"/api-reference/overview"}]},{"group":"Text to Speech","pages":[{"title":"Text to Speech quickstart","sidebarTitle":"TTS quickstart","href":"/quickstart"},{"group":"Models \u0026 languages","pages":[{"title":"TTS Models \u0026 Migration","sidebarTitle":"Models \u0026 migration","href":"/api-reference/tts/models"},{"title":"V3 Language Codes","sidebarTitle":"V3 language codes","href":"/api-reference/tts/v3-language-codes"},{"title":"Model V3.5 High Quality language codes","sidebarTitle":"V3.5 language codes","href":"/api-reference/tts/v35-language-codes"}]},{"group":"TTS API reference","pages":[{"title":"Create speech","api":"POST https://api.myvocal.ai/sound_clone/api/v1/tts","href":"/api-reference/tts/tts"},{"title":"Stream speech","api":"POST https://api.myvocal.ai/sound_clone/api/v1/tts/stream","href":"/api-reference/tts/ttsStream"}]},{"group":"TTS History","pages":[{"title":"List TTS history","api":"GET https://api.myvocal.ai/sound_clone/api/v1/tts/list","href":"/api-reference/history/ttsList"},{"title":"Get TTS audio URLs","api":"POST https://api.myvocal.ai/sound_clone/api/v1/tts/query","href":"/api-reference/history/ttsListUrl"},{"title":"Delete TTS history","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/tts","href":"/api-reference/history/deleteTTS"}]}]},{"group":"Speech to Text","pages":[{"title":"Speech to Text — Batch quickstart","sidebarTitle":"Batch quickstart","href":"/guides/stt-batch-quickstart"},{"title":"Speech to Text — Real-time quickstart","sidebarTitle":"Real-time quickstart","href":"/guides/stt-realtime-quickstart"},{"group":"Real-time SDKs","pages":[{"title":"Real-time SDKs — install","sidebarTitle":"Install","href":"/sdks/stt-realtime/overview"},{"title":"Real-time SDK — Python","sidebarTitle":"Python","href":"/sdks/stt-realtime/python"},{"title":"Real-time SDK — Java","sidebarTitle":"Java","href":"/sdks/stt-realtime/java"},{"title":"Real-time SDK — Go","sidebarTitle":"Go","href":"/sdks/stt-realtime/go"},{"title":"Real-time SDKs — behaviour guide","sidebarTitle":"Behavior guide","href":"/sdks/stt-realtime/behavior"}]},{"group":"STT API reference","pages":[{"title":"Speech to Text capabilities","api":"GET https://api.myvocal.ai/sound_clone/api/v1/stt/capabilities","href":"/api-reference/stt/capabilities"},{"group":"Batch uploads","pages":[{"title":"Create an upload","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/uploads","href":"/api-reference/stt/createUpload"},{"title":"Sign an upload part","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/uploads/{uploadId}/parts/{partNumber}","href":"/api-reference/stt/signUploadPart"},{"title":"Complete an upload","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/uploads/{uploadId}/complete","href":"/api-reference/stt/completeUpload"},{"title":"Get an upload","api":"GET https://api.myvocal.ai/sound_clone/api/v1/stt/uploads/{uploadId}","href":"/api-reference/stt/getUpload"}]},{"group":"Batch transcriptions","pages":[{"title":"Create a transcription","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/transcriptions","href":"/api-reference/stt/createTranscription"},{"title":"Get a transcription","api":"GET https://api.myvocal.ai/sound_clone/api/v1/stt/transcriptions/{transcriptionId}","href":"/api-reference/stt/getTranscription"},{"title":"List transcriptions","api":"GET https://api.myvocal.ai/sound_clone/api/v1/stt/transcriptions","href":"/api-reference/stt/listTranscriptions"},{"title":"Download a transcription","api":"GET https://api.myvocal.ai/sound_clone/api/v1/stt/transcriptions/{transcriptionId}/download","href":"/api-reference/stt/downloadTranscription"},{"title":"Delete a transcription","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/stt/transcriptions/{transcriptionId}","description":"Delete a task and its content.","href":"/api-reference/stt/deleteTranscription"}]},{"group":"Real-time sessions","pages":[{"title":"Create a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions","href":"/api-reference/stt/createSession"},{"title":"Get a real-time session","api":"GET https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions/{sessionId}","description":"Read the live state, usage and lines of a real-time session.","href":"/api-reference/stt/getSession"},{"title":"Pause a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions/{sessionId}/pause","href":"/api-reference/stt/pauseSession"},{"title":"Resume a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions/{sessionId}/resume","href":"/api-reference/stt/resumeSession"},{"title":"Finish a real-time session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions/{sessionId}/finish","href":"/api-reference/stt/finishSession"},{"title":"Create a browser ticket","api":"POST https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions/{sessionId}/tickets","href":"/api-reference/stt/createTicket"}]}]},{"title":"Speech to Text availability","sidebarTitle":"Availability","href":"/guides/stt-availability"}]},{"group":"Voice cloning","pages":[{"title":"How to use voices","sidebarTitle":"How to use voices","href":"/guides/voice-quickstart"},{"group":"Voice API reference","pages":[{"title":"Create a TTS voice","api":"POST https://docs.myvocal.ai/sound_clone/api/v1/voices/tts","href":"/api-reference/voice/addTTSVoice"},{"title":"Create a Cover voice","api":"POST https://docs.myvocal.ai/sound_clone/api/v1/voices/vc","href":"/api-reference/voice/addCoverVoice"},{"title":"Improve a TTS voice","api":"PUT https://docs.myvocal.ai/sound_clone/api/v1/voices/tts/{voiceId}","href":"/api-reference/voice/editTTSVoice"},{"title":"Improve a Cover voice","api":"PUT https://docs.myvocal.ai/sound_clone/api/v1/voices/vc/{voiceId}","href":"/api-reference/voice/editCoverVoice"},{"title":"List voices","api":"GET https://api.myvocal.ai/sound_clone/api/v1/voices","href":"/api-reference/voice/list"},{"title":"Rename a voice","api":"PUT https://api.myvocal.ai/sound_clone/api/v1/voices/rename/{id}","href":"/api-reference/voice/updateVoiceName"},{"title":"Delete a voice","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/voices/{id}","href":"/api-reference/voice/delete"}]}]},{"group":"AI Cover","pages":[{"title":"AI Cover quickstart","sidebarTitle":"Quickstart","href":"/guides/cover-quickstart"},{"title":"Generate a cover","api":"POST https://api.myvocal.ai/sound_clone/api/v1/cover","href":"/api-reference/cover/cover"},{"title":"Cover callbacks","href":"/callback"},{"group":"Cover History","pages":[{"title":"List Cover history","api":"GET https://api.myvocal.ai/sound_clone/sound_clone/api/v1/cover/list","href":"/api-reference/history/coverList"},{"title":"Get Cover audio URLs","api":"POST https://api.myvocal.ai/sound_clone/api/v1/cover/query","href":"/api-reference/history/coverListUrl"},{"title":"Delete Cover history","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/cover","href":"/api-reference/history/deleteCover"}]}]},{"group":"Text to Music","pages":[{"title":"Text-to-Music quickstart","sidebarTitle":"Quickstart","href":"/guides/music-quickstart"},{"group":"Music API reference","pages":[{"title":"Music capabilities","api":"GET https://api.myvocal.ai/sound_clone/api/v1/music/capabilities","href":"/api-reference/music/capabilities"},{"group":"Create and generate","pages":[{"title":"Create a music project","api":"POST https://api.myvocal.ai/sound_clone/api/v1/music/projects","href":"/api-reference/music/createProject"},{"title":"Get a music job","api":"GET https://api.myvocal.ai/sound_clone/api/v1/music/jobs/{jobId}","href":"/api-reference/music/getJob"},{"title":"Get a music project","api":"GET https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}","href":"/api-reference/music/getProject"},{"title":"Update the creative brief","api":"PUT https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/brief","href":"/api-reference/music/updateBrief"},{"title":"Edit the arrangement","api":"PUT https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/arrangement","href":"/api-reference/music/updateArrangement"},{"title":"Regenerate the arrangement","api":"POST https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/arrangement/regenerate","href":"/api-reference/music/regenerateArrangement"},{"title":"Quote a music generation","api":"POST https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/quotes","href":"/api-reference/music/createQuote"},{"title":"Generate the song","api":"POST https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/generations","href":"/api-reference/music/createGeneration"},{"title":"Get a playback URL","api":"GET https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/playback-url","href":"/api-reference/music/playbackUrl"},{"title":"Download the song","api":"GET https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/download","href":"/api-reference/music/download"}]},{"group":"Manage projects","pages":[{"title":"List music projects","api":"GET https://api.myvocal.ai/sound_clone/api/v1/music/projects","href":"/api-reference/music/listProjects"},{"title":"Create a project version","api":"POST https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/versions","href":"/api-reference/music/createVersion"},{"title":"Rename a music project","api":"PATCH https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}/name","href":"/api-reference/music/renameProject"},{"title":"Delete a music project","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/music/projects/{projectId}","href":"/api-reference/music/deleteProject"}]}]}]},{"group":"Interpretation","pages":[{"title":"Interpretation quickstart","sidebarTitle":"Quickstart","href":"/guides/interpretation-quickstart"},{"title":"Realtime translation quickstart","href":"/guides/interpretation-realtime-quickstart"},{"title":"Realtime translation API reference","href":"/api-reference/interpretation/realtime"},{"group":"Interpretation API reference","pages":[{"title":"Interpretation capabilities","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/capabilities","href":"/api-reference/interpretation/capabilities"},{"group":"Upload the source","pages":[{"title":"Create an upload session","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/uploads","href":"/api-reference/interpretation/createUpload"},{"title":"Sign an upload part","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/uploads/{uploadId}/parts","href":"/api-reference/interpretation/signUploadPart"},{"title":"Complete an upload","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/uploads/{uploadId}/complete","href":"/api-reference/interpretation/completeUpload"},{"title":"Get upload status","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/uploads/{uploadId}","href":"/api-reference/interpretation/getUpload"},{"title":"Remove the interpretation source","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/source","href":"/api-reference/interpretation/deleteSource"}]},{"group":"Quote and generate","pages":[{"title":"Patch the interpretation draft","api":"PATCH https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/draft","href":"/api-reference/interpretation/patchDraft"},{"title":"Quote interpretation targets","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/quotes","href":"/api-reference/interpretation/createQuote"},{"title":"Accept an interpretation quote","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/generations","href":"/api-reference/interpretation/createGeneration"},{"title":"Get an interpretation job","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/jobs/{jobId}","href":"/api-reference/interpretation/getJob"},{"title":"Get a retry plan","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/targets/{targetId}/retry-plan","href":"/api-reference/interpretation/retryPlan"},{"title":"Retry a failed target","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/targets/{targetId}/retry","href":"/api-reference/interpretation/retryTarget"}]},{"group":"Results and export","pages":[{"title":"Play an interpretation asset","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/assets/{assetId}/playback","href":"/api-reference/interpretation/playback"},{"title":"Create an export","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/targets/{targetId}/exports","href":"/api-reference/interpretation/createExport"},{"title":"Download an export","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/exports/{exportId}/download","href":"/api-reference/interpretation/downloadExport"}]},{"group":"Manage projects","pages":[{"title":"Create an interpretation project","api":"POST https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects","href":"/api-reference/interpretation/createProject"},{"title":"Get an interpretation project","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}","href":"/api-reference/interpretation/getProject"},{"title":"List interpretation projects","api":"GET https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects","href":"/api-reference/interpretation/listProjects"},{"title":"Rename an interpretation project","api":"PATCH https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}/name","href":"/api-reference/interpretation/renameProject"},{"title":"Delete an interpretation project","api":"DELETE https://api.myvocal.ai/sound_clone/api/v1/interpretation/projects/{projectId}","href":"/api-reference/interpretation/deleteProject"}]}]}]},{"group":"Integration concepts","pages":[{"title":"Characters, quotes and billing","sidebarTitle":"Characters \u0026 billing","href":"/guides/characters-and-quotes"},{"title":"Async jobs, polling and retries","sidebarTitle":"Async jobs, polling \u0026 retries","href":"/guides/async-jobs-and-retries"}]}]},"basePath":"","title":"Create a real-time session - MyVocal.AI","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js"]}