Tts - TypeScript SDK
Tts - TypeScript SDK
Tts method reference
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Overview
Text-to-speech endpoints
Available Operations
- createSpeech - Create speech
createSpeech
Synthesizes audio from the input text
Example Usage
1 import { OpenRouter } from "@openrouter/sdk"; 2 3 const openRouter = new OpenRouter({ 4 httpReferer: "<value>", 5 appTitle: "<value>", 6 appCategories: "<value>", 7 apiKey: process.env["OPENROUTER_API_KEY"] ?? "", 8 }); 9 10 async function run() { 11 const result = await openRouter.tts.createSpeech({ 12 speechRequest: { 13 input: "Hello world", 14 model: "elevenlabs/eleven-turbo-v2", 15 speed: 1, 16 voice: "alloy", 17 }, 18 }); 19 20 console.log(result); 21 } 22 23 run();
Standalone function
The standalone function version of this method:
1 import { OpenRouterCore } from "@openrouter/sdk/core.js"; 2 import { ttsCreateSpeech } from "@openrouter/sdk/funcs/ttsCreateSpeech.js"; 3 4 // Use `OpenRouterCore` for best tree-shaking performance. 5 // You can create one instance of it to use across an application. 6 const openRouter = new OpenRouterCore({ 7 httpReferer: "<value>", 8 appTitle: "<value>", 9 appCategories: "<value>", 10 apiKey: process.env["OPENROUTER_API_KEY"] ?? "", 11 }); 12 13 async function run() { 14 const res = await ttsCreateSpeech(openRouter, { 15 speechRequest: { 16 input: "Hello world", 17 model: "elevenlabs/eleven-turbo-v2", 18 speed: 1, 19 voice: "alloy", 20 }, 21 }); 22 if (res.ok) { 23 const { value: result } = res; 24 console.log(result); 25 } else { 26 console.log("ttsCreateSpeech failed:", res.error); 27 } 28 } 29 30 run();
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.CreateAudioSpeechRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<ReadableStream<Uint8Array>>
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 | */* |