Transcriptions - Python SDK

Transcriptions method reference

Transcriptions - Python SDK

Transcriptions method reference

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

Overview

Speech-to-text endpoints

Available Operations

create_transcription - Create transcription

create_transcription

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

Example Usage

1 from openrouter import OpenRouter
2 import os
3 
4 with OpenRouter(
5     http_referer="<value>",
6     x_open_router_title="<value>",
7     x_open_router_categories="<value>",
8     api_key=os.getenv("OPENROUTER_API_KEY", ""),
9 ) as open_router:
10 
11     res = open_router.stt.create_transcription(input_audio={
12         "data": "UklGRiQA...",
13         "format_": "wav",
14     }, model="openai/whisper-large-v3", language="en")
15 
16     # Handle response
17     print(res)

Parameters

Parameter	Type	Required	Description	Example
`input_audio`	components.STTInputAudio	✔️	Base64-encoded audio to transcribe	`{"data": "UklGRiQA...","format": "wav"}`
`model`	str	✔️	STT model identifier	openai/whisper-large-v3
`http_referer`	Optional[str]	➖	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_title`	Optional[str]	➖	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`x_open_router_categories`	Optional[str]	➖	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`language`	Optional[str]	➖	ISO-639-1 language code (e.g., “en”, “ja”). Auto-detected if omitted.	en
`provider`	Optional[components.STTRequestProvider]	➖	Provider-specific passthrough configuration
`temperature`	Optional[float]	➖	Sampling temperature for transcription	0
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

components.STTResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.UnauthorizedResponseError	401	application/json
errors.PaymentRequiredResponseError	402	application/json
errors.NotFoundResponseError	404	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.BadGatewayResponseError	502	application/json
errors.ServiceUnavailableResponseError	503	application/json
errors.EdgeNetworkTimeoutResponseError	524	application/json
errors.ProviderOverloadedResponseError	529	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

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

Overview

Speech-to-text endpoints

Available Operations

create_transcription - Create transcription

create_transcription

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

Example Usage

1 from openrouter import OpenRouter
2 import os
3 
4 with OpenRouter(
5     http_referer="<value>",
6     x_open_router_title="<value>",
7     x_open_router_categories="<value>",
8     api_key=os.getenv("OPENROUTER_API_KEY", ""),
9 ) as open_router:
10 
11     res = open_router.stt.create_transcription(input_audio={
12         "data": "UklGRiQA...",
13         "format_": "wav",
14     }, model="openai/whisper-large-v3", language="en")
15 
16     # Handle response
17     print(res)

Parameters

Parameter	Type	Required	Description	Example
`input_audio`	components.STTInputAudio	✔️	Base64-encoded audio to transcribe	`{"data": "UklGRiQA...","format": "wav"}`
`model`	str	✔️	STT model identifier	openai/whisper-large-v3
`http_referer`	Optional[str]	➖	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_title`	Optional[str]	➖	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`x_open_router_categories`	Optional[str]	➖	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`language`	Optional[str]	➖	ISO-639-1 language code (e.g., “en”, “ja”). Auto-detected if omitted.	en
`provider`	Optional[components.STTRequestProvider]	➖	Provider-specific passthrough configuration
`temperature`	Optional[float]	➖	Sampling temperature for transcription	0
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

components.STTResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.UnauthorizedResponseError	401	application/json
errors.PaymentRequiredResponseError	402	application/json
errors.NotFoundResponseError	404	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.BadGatewayResponseError	502	application/json
errors.ServiceUnavailableResponseError	503	application/json
errors.EdgeNetworkTimeoutResponseError	524	application/json
errors.ProviderOverloadedResponseError	529	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

1	from openrouter import OpenRouter
2	import os
3
4	with OpenRouter(
5	http_referer="<value>",
6	x_open_router_title="<value>",
7	x_open_router_categories="<value>",
8	api_key=os.getenv("OPENROUTER_API_KEY", ""),
9	) as open_router:
10
11	res = open_router.stt.create_transcription(input_audio={
12	"data": "UklGRiQA...",
13	"format_": "wav",
14	}, model="openai/whisper-large-v3", language="en")
15
16	# Handle response
17	print(res)