Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll GET /v1/jobs/{id} for the transcript.
HTTPS URL of the recording, fetched by the provider. Signed URLs are fine; it must stay reachable until the provider has read it. No embedded credentials or fragments.
Recognition hints: names, jargon, product terms. Supported on AssemblyAI, Deepgram Nova-3, and ElevenLabs Scribe v2; other models ignore them with a warning.
Provider-native options, validated by the adapter. Model selection lives here. Transport settings such as URLs, callbacks, and authentication cannot be overridden.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Helve","description":"One key, one request shape, one bill for web search, page extraction, and transcription across every provider.","colors":{"primary":"#14655a","light":"#37a08f","dark":"#14655a"},"logo":{"light":"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/logo/light.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=eb97b007a2ec2b7125f02ee2cc65b8d8","dark":"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/logo/dark.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=8b290a25b599307eeebdfb7fb4a04786","href":"https://helve.dev"},"favicon":"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/favicon.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=51062c58010b78bf395309f9beb81339","appearance":{"default":"system"},"navbar":{"links":[{"href":"https://helve.dev","label":"Dashboard"}],"primary":{"type":"button","label":"Get an API key","href":"https://helve.dev"}},"footer":{"socials":{"github":"https://github.com/youssefarizk/tool-marketplace"},"links":[{"header":"Helve","items":[{"label":"Dashboard","href":"https://helve.dev"},{"label":"Terms","href":"https://helve.dev/terms"},{"label":"Privacy","href":"https://helve.dev/privacy"}]}]},"fonts":{"heading":{"family":"Archivo","weight":700}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"helve","hasAudioNarration":false,"actualSubdomain":"helve","customDomains":["docs.helve.dev"],"gitSource":{"type":"github","owner":"youssefarizk","repo":"tool-marketplace","deployBranch":"staging","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aabaa10096eb2d1ccbcd211","collectionId":"4119f034-be56-40c8-b787-c98a041ecd8f","liveDeploymentHistoryId":"6aabaa10096eb2d1ccbcd211","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6aabaa10096eb2d1ccbcd211","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"API reference","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Tools","count":3},{"language":"default","tag":"Transcription","count":2},{"language":"default","tag":"Extract","count":1},{"language":"default","tag":"Search","count":1},{"language":"default","tag":"Integrations","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"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":"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":"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":"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":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/create-transcription","slug":"/api-reference/create-transcription","pageMetadata":{"title":"Transcribe a recording","openapi":"openapi.json POST /v1/transcriptions","description":"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll `GET /v1/jobs/{id}` for the transcript.","href":"/api-reference/create-transcription"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll \", _jsx(_components.code, {\n children: \"GET /v1/jobs/{id}\"\n }), \" for the transcript.\"]\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":"Transcribe a recording","openapi":"openapi.json POST /v1/transcriptions","description":"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll `GET /v1/jobs/{id}` for the transcript.","href":"/api-reference/create-transcription"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createTranscription","tags":["Transcription"],"summary":"Transcribe a recording","description":"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll `GET /v1/jobs/{id}` for the transcript.","security":["360c5267-1234-4984-ba5b-1b0d34ebe913"],"requestBody":"20cb8661-3bbd-429a-8c18-150535aa2824","responses":{"202":"fdf6bdbb-db3c-4255-8c46-cf3ace321835","400":"e84e0aad-39c9-4095-8296-c9fda117d336","401":"a1a063ff-fb45-4d9a-8048-af1cf6bcc907","402":"9e6b943e-2194-4a38-9047-1153516ebaaf","404":"9439de06-6bf3-4e48-a790-cc441123ea3c","503":"ae83eb8f-e183-449e-b53f-3c230de87f95"},"method":"post","type":"path","servers":["336702ba-c08f-4f5b-b5c5-aca0fb2290c6"],"path":"/v1/transcriptions","baseUrlOptions":["https://helve.dev"],"title":"Transcribe a recording","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"example":{"audio_url":"https://example.com/recordings/standup.mp3","provider":"auto","diarize":true,"keyterms":["Helve","Stirrup"]},"schema":{"type":"object","properties":{"audio_url":{"type":"string","format":"uri","description":"HTTPS URL of the recording, fetched by the provider. Signed URLs are fine; it must stay reachable until the provider has read it. No embedded credentials or fragments.","isRequired":true,"uniqueKey":"audio_url","typeLabel":"string\u003curi>"},"provider":{"type":"string","enum":["assemblyai","deepgram","elevenlabs","auto"],"description":"Which speech-to-text provider runs the job. `auto` (default) picks the first configured provider. The choice is persisted on the job before execution.","uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","pattern":"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$","description":"BCP-47-style language tag such as `en` or `en-US`. Omit to let the provider detect the language.","uniqueKey":"language","typeLabel":"string"},"diarize":{"type":"boolean","description":"Label speakers in `words` as `speaker_0`, `speaker_1`, … in order of first appearance. Default false.","uniqueKey":"diarize","typeLabel":"boolean"},"keyterms":{"type":"array","items":{"type":"string","uniqueKey":"keyterms.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Recognition hints: names, jargon, product terms. Supported on AssemblyAI, Deepgram Nova-3, and ElevenLabs Scribe v2; other models ignore them with a warning.","uniqueKey":"keyterms","typeLabel":"string[]"},"timestamps":{"type":"string","enum":["word","none"],"description":"`word` (default) returns per-word timings in `result.words`; `none` omits them.","uniqueKey":"timestamps","typeLabel":"enum\u003cstring>"},"strict":{"type":"boolean","description":"When true, any option the selected provider or model cannot honour rejects the request instead of producing a warning. Default false.","uniqueKey":"strict","typeLabel":"boolean"},"provider_options":{"type":"object","properties":{"assemblyai":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.assemblyai.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.assemblyai.additionalProperties","typeLabel":"null"},"description":"AssemblyAI-native options, for example `{ \"model\": \"best\" }`.","uniqueKey":"provider_options.assemblyai","typeLabel":"object"},"deepgram":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.deepgram.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.deepgram.additionalProperties","typeLabel":"null"},"description":"Deepgram-native options, for example `{ \"model\": \"nova-3\" }`.","uniqueKey":"provider_options.deepgram","typeLabel":"object"},"elevenlabs":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.elevenlabs.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.elevenlabs.additionalProperties","typeLabel":"null"},"description":"ElevenLabs-native options, for example `{ \"model_id\": \"scribe_v2\" }`.","uniqueKey":"provider_options.elevenlabs","typeLabel":"object"}},"additionalProperties":false,"description":"Provider-native options, validated by the adapter. Model selection lives here. Transport settings such as URLs, callbacks, and authentication cannot be overridden.","uniqueKey":"provider_options","typeLabel":"object"}},"required":["audio_url"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"audio_url":"https://example.com/recordings/standup.mp3","provider":"auto","diarize":true,"keyterms":["Helve","Stirrup"]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"fdf6bdbb-db3c-4255-8c46-cf3ace321835":{"description":"Transcription accepted","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^job_[0-9a-f-]{36}$","description":"The job id, `job_…`. Poll `GET /v1/jobs/{id}` with it.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"tool":{"type":"string","enum":["transcription"],"isRequired":true,"uniqueKey":"tool","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["queued","running","completed","failed"],"description":"`queued` and `running` are in progress; `completed` carries `result`; `failed` carries `error`.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["assemblyai","deepgram","elevenlabs"],"description":"The provider selected for this job, resolved from `auto`.","isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"The provider model the job will run on.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"warnings.items.[INDEX].param","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"description":"Options the selected provider or model cannot honour. Empty when the request was accepted exactly.","isRequired":true,"uniqueKey":"warnings","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"required":["id","tool","status","provider","model","warnings","created_at"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","tool":"transcription","status":"queued","provider":"assemblyai","model":"\u003cstring>","warnings":[{"code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>"}],"created_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"e84e0aad-39c9-4095-8296-c9fda117d336":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a1a063ff-fb45-4d9a-8048-af1cf6bcc907":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9e6b943e-2194-4a38-9047-1153516ebaaf":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9439de06-6bf3-4e48-a790-cc441123ea3c":{"description":"Job not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ae83eb8f-e183-449e-b53f-3c230de87f95":{"description":"Durable execution or provider unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"360c5267-1234-4984-ba5b-1b0d34ebe913":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key from the dashboard, `sk_live_…`, sent as `Authorization: Bearer sk_live_…`.","scopes":[]}}},"servers":{"336702ba-c08f-4f5b-b5c5-aca0fb2290c6":{"url":"https://helve.dev","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from the dashboard, `sk_live_…`, sent as `Authorization: Bearer sk_live_…`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from the dashboard, `sk_live_…`, sent as `Authorization: Bearer sk_live_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"helve","siteName":"Helve","title":"Transcribe a recording - Helve","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T12:08:44.770Z","originalFileLocation":"api-reference/create-transcription.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=\"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll GET /v1/jobs/{id} for the transcript.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Helve\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Transcribe a recording - Helve\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll GET /v1/jobs/{id} for the transcript.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Helve\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.helve.dev/api-reference/create-transcription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://helve.mintlify.app/_mintlify/api/og/v2?division=Transcription\u0026amp;title=Transcribe+a+recording\u0026amp;description=Submits+a+prerecorded+file+by+URL+and+returns+a+job+immediately.+Helve+records+the+attempt+before+contacting+the+provider%2C+retries+rate+limits%2C+never+re-sends+a\u0026amp;theme=0f571ea141e669259272653e\u0026amp;signature=56448626bd455586d65670a300c373ad808dac4af159b61700009f96e089ae6b\">\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=\"Transcribe a recording - Helve\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll GET /v1/jobs/{id} for the transcript.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://helve.mintlify.app/_mintlify/api/og/v2?division=Transcription\u0026amp;title=Transcribe+a+recording\u0026amp;description=Submits+a+prerecorded+file+by+URL+and+returns+a+job+immediately.+Helve+records+the+attempt+before+contacting+the+provider%2C+retries+rate+limits%2C+never+re-sends+a\u0026amp;theme=0f571ea141e669259272653e\u0026amp;signature=56448626bd455586d65670a300c373ad808dac4af159b61700009f96e089ae6b\">\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/helve/Mj0uqQ8YCWh4A1Yd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Helve\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#14655a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.helve.dev/api-reference/create-transcription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-transcription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.helve.dev/#organization\",\"name\":\"Helve\",\"url\":\"https://docs.helve.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/logo/light.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=eb97b007a2ec2b7125f02ee2cc65b8d8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.helve.dev#website\",\"name\":\"Helve\",\"url\":\"https://docs.helve.dev\",\"publisher\":{\"@id\":\"https://docs.helve.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.helve.dev/api-reference/create-transcription#webpage\",\"url\":\"https://docs.helve.dev/api-reference/create-transcription\",\"name\":\"Transcribe a recording\",\"description\":\"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll GET /v1/jobs/{id} for the transcript.\",\"dateModified\":\"2026-09-16T12:08:44.770Z\",\"isPartOf\":{\"@id\":\"https://docs.helve.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.helve.dev/api-reference/create-transcription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.helve.dev/api-reference/create-transcription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Helve\",\"item\":\"https://docs.helve.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transcribe a recording\",\"item\":\"https://docs.helve.dev/api-reference/create-transcription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.helve.dev/api-reference/create-transcription#apireference\",\"headline\":\"Transcribe a recording\",\"name\":\"Transcribe a recording\",\"description\":\"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll GET /v1/jobs/{id} for the transcript.\",\"url\":\"https://docs.helve.dev/api-reference/create-transcription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.helve.dev/api-reference/create-transcription#webpage\"},\"dateModified\":\"2026-09-16T12:08:44.770Z\",\"publisher\":{\"@id\":\"https://docs.helve.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.helve.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Helve\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Helve","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Search","pages":[{"title":"Search the web","openapi":"openapi.json POST /v1/search","href":"/api-reference/search"}]},{"group":"Extract","pages":[{"title":"Extract page content","openapi":"openapi.json POST /v1/extract","description":"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a `query`. URLs the provider cannot fetch are listed in `failed` rather than failing the whole request.","href":"/api-reference/extract"}]},{"group":"Transcription","pages":[{"title":"Transcribe a recording","openapi":"openapi.json POST /v1/transcriptions","href":"/api-reference/create-transcription"},{"title":"Get a job","openapi":"openapi.json GET /v1/jobs/{id}","description":"One read for the whole lifecycle: state while the job runs, the transcript in `result` once it completes, the reason in `error` once it fails. Jobs are retained for seven days.","href":"/api-reference/get-job"}]}]}]},"title":"Transcribe a recording - Helve","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}