For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
        • Models
        • STTRequest
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Python SDK
    • Overview
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Example Usage
  • Fields
TypeScript SDKAPI ReferenceModels

STTRequest - TypeScript SDK

STTRequest type definition
Was this page helpful?
Previous

OAuth - TypeScript SDK

OAuth method reference
Next
Built with

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Speech-to-text request input. Accepts a JSON body with input_audio containing base64-encoded audio.

Example Usage

1import { STTRequest } from "@openrouter/sdk/models";
2
3let value: STTRequest = {
4 inputAudio: {
5 data: "UklGRiQA...",
6 format: "wav",
7 },
8 model: "openai/whisper-large-v3",
9};

Fields

FieldTypeRequiredDescriptionExample
inputAudiomodels.STTInputAudio✔️Base64-encoded audio to transcribe{"data": "UklGRiQA...","format": "wav"}
languagestring➖ISO-639-1 language code (e.g., “en”, “ja”). Auto-detected if omitted.en
modelstring✔️STT model identifieropenai/whisper-large-v3
providermodels.STTRequestProvider➖Provider-specific passthrough configuration
temperaturenumber➖Sampling temperature for transcription0