|
| 1 | +# Speechifyinc TypeScript Library |
| 2 | + |
| 3 | +[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fspeechifyinc%2Fspeechify-api-sdk-typescript) |
| 4 | +[](https://www.npmjs.com/package/) |
| 5 | + |
| 6 | +The Speechifyinc TypeScript library provides convenient access to the Speechifyinc API from TypeScript. |
| 7 | + |
| 8 | +## Installation |
| 9 | + |
| 10 | +```sh |
| 11 | +npm i -s |
| 12 | +``` |
| 13 | + |
| 14 | +## Reference |
| 15 | + |
| 16 | +A full reference for this library is available [here](./reference.md). |
| 17 | + |
| 18 | +## Usage |
| 19 | + |
| 20 | +Instantiate and use the client with the following: |
| 21 | + |
| 22 | +```typescript |
| 23 | +import { SpeechifyClient } from ""; |
| 24 | + |
| 25 | +const client = new SpeechifyClient({ token: "YOUR_TOKEN" }); |
| 26 | +await client.tts.audio.speech({ |
| 27 | + input: "input", |
| 28 | + voiceId: "voice_id", |
| 29 | +}); |
| 30 | +``` |
| 31 | + |
| 32 | +## Request And Response Types |
| 33 | + |
| 34 | +The SDK exports all request and response types as TypeScript interfaces. Simply import them with the |
| 35 | +following namespace: |
| 36 | + |
| 37 | +```typescript |
| 38 | +import { Speechify } from "Speechify"; |
| 39 | + |
| 40 | +const request: Speechify.GetSpeechRequest = { |
| 41 | + ... |
| 42 | +}; |
| 43 | +``` |
| 44 | + |
| 45 | +## Exception Handling |
| 46 | + |
| 47 | +When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error |
| 48 | +will be thrown. |
| 49 | + |
| 50 | +```typescript |
| 51 | +import { SpeechifyError } from "Speechify"; |
| 52 | + |
| 53 | +try { |
| 54 | + await client.tts.audio.speech(...); |
| 55 | +} catch (err) { |
| 56 | + if (err instanceof SpeechifyError) { |
| 57 | + console.log(err.statusCode); |
| 58 | + console.log(err.message); |
| 59 | + console.log(err.body); |
| 60 | + } |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +## Advanced |
| 65 | + |
| 66 | +### Additional Headers |
| 67 | + |
| 68 | +If you would like to send additional headers as part of the request, use the `headers` request option. |
| 69 | + |
| 70 | +```typescript |
| 71 | +const response = await client.tts.audio.speech(..., { |
| 72 | + headers: { |
| 73 | + 'X-Custom-Header': 'custom value' |
| 74 | + } |
| 75 | +}); |
| 76 | +``` |
| 77 | + |
| 78 | +### Retries |
| 79 | + |
| 80 | +The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long |
| 81 | +as the request is deemed retryable and the number of retry attempts has not grown larger than the configured |
| 82 | +retry limit (default: 2). |
| 83 | + |
| 84 | +A request is deemed retryable when any of the following HTTP status codes is returned: |
| 85 | + |
| 86 | +- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) |
| 87 | +- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) |
| 88 | +- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) |
| 89 | + |
| 90 | +Use the `maxRetries` request option to configure this behavior. |
| 91 | + |
| 92 | +```typescript |
| 93 | +const response = await client.tts.audio.speech(..., { |
| 94 | + maxRetries: 0 // override maxRetries at the request level |
| 95 | +}); |
| 96 | +``` |
| 97 | + |
| 98 | +### Timeouts |
| 99 | + |
| 100 | +The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior. |
| 101 | + |
| 102 | +```typescript |
| 103 | +const response = await client.tts.audio.speech(..., { |
| 104 | + timeoutInSeconds: 30 // override timeout to 30s |
| 105 | +}); |
| 106 | +``` |
| 107 | + |
| 108 | +### Aborting Requests |
| 109 | + |
| 110 | +The SDK allows users to abort requests at any point by passing in an abort signal. |
| 111 | + |
| 112 | +```typescript |
| 113 | +const controller = new AbortController(); |
| 114 | +const response = await client.tts.audio.speech(..., { |
| 115 | + abortSignal: controller.signal |
| 116 | +}); |
| 117 | +controller.abort(); // aborts the request |
| 118 | +``` |
| 119 | + |
| 120 | +### Runtime Compatibility |
| 121 | + |
| 122 | +The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following |
| 123 | +runtimes: |
| 124 | + |
| 125 | +- Node.js 18+ |
| 126 | +- Vercel |
| 127 | +- Cloudflare Workers |
| 128 | +- Deno v1.25+ |
| 129 | +- Bun 1.0+ |
| 130 | +- React Native |
| 131 | + |
| 132 | +### Customizing Fetch Client |
| 133 | + |
| 134 | +The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an |
| 135 | +unsupported environment, this provides a way for you to break glass and ensure the SDK works. |
| 136 | + |
| 137 | +```typescript |
| 138 | +import { SpeechifyClient } from "Speechify"; |
| 139 | + |
| 140 | +const client = new SpeechifyClient({ |
| 141 | + ... |
| 142 | + fetcher: // provide your implementation here |
| 143 | +}); |
| 144 | +``` |
| 145 | + |
| 146 | +## Contributing |
| 147 | + |
| 148 | +While we value open-source contributions to this SDK, this library is generated programmatically. |
| 149 | +Additions made directly to this library would have to be moved over to our generation code, |
| 150 | +otherwise they would be overwritten upon the next generated release. Feel free to open a PR as |
| 151 | +a proof of concept, but know that we will not be able to merge it as-is. We suggest opening |
| 152 | +an issue first to discuss with us! |
| 153 | + |
| 154 | +On the other hand, contributions to the README are always very welcome! |
![fern-api[bot]](https://avatars.githubusercontent.com/in/244756?v=4&size=40){kind=avatar}
0 commit comments