Skip to main content

Overview

Speech-to-text endpoints

Available Operations

create_transcription

Transcribes audio into text. Accepts base64-encoded audio input and returns the transcribed text.

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    http_referer="<value>",
    x_open_router_title="<value>",
    x_open_router_categories="<value>",
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.stt.create_transcription(input_audio={
        "data": "UklGRiQA...",
        "format_": "wav",
    }, model="openai/whisper-large-v3", language="en")

    # Handle response
    print(res)

Parameters

ParameterTypeRequiredDescriptionExample
input_audiocomponents.STTInputAudio:heavy_check_mark:Base64-encoded audio to transcribe{
“data”: “UklGRiQA…”,
“format”: “wav”
}
modelstr:heavy_check_mark:STT model identifieropenai/whisper-large-v3
http_refererOptional[str]:heavy_minus_sign:The app identifier should be your app’s URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
x_open_router_titleOptional[str]:heavy_minus_sign:The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
x_open_router_categoriesOptional[str]:heavy_minus_sign:Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
languageOptional[str]:heavy_minus_sign:ISO-639-1 language code (e.g., “en”, “ja”). Auto-detected if omitted.en
providerOptional[components.STTRequestProvider]:heavy_minus_sign:Provider-specific passthrough configuration
temperatureOptional[float]:heavy_minus_sign:Sampling temperature for transcription0
retriesOptional[utils.RetryConfig]:heavy_minus_sign:Configuration to override the default retry behavior of the client.

Response

components.STTResponse

Errors

Error TypeStatus CodeContent Type
errors.BadRequestResponseError400application/json
errors.UnauthorizedResponseError401application/json
errors.PaymentRequiredResponseError402application/json
errors.NotFoundResponseError404application/json
errors.TooManyRequestsResponseError429application/json
errors.InternalServerResponseError500application/json
errors.BadGatewayResponseError502application/json
errors.ServiceUnavailableResponseError503application/json
errors.EdgeNetworkTimeoutResponseError524application/json
errors.ProviderOverloadedResponseError529application/json
errors.OpenRouterDefaultError4XX, 5XX*/*