BYOK (Bring Your Own Key) lets you pass your own upstream provider API key on TTS requests. The gateway forwards that key to the provider, so billing and rate limits run against your provider account. The SLNG gateway’s TTS cache still applies on top.Documentation Index
Fetch the complete documentation index at: https://docs.slng.ai/llms.txt
Use this file to discover all available pages before exploring further.
Placeholders
The snippets below use these placeholders. Replace them before running the code.| Placeholder | Replace with |
|---|---|
SLNG_API_KEY | An SLNG API key from app.slng.ai/api-keys |
YOUR_PROVIDER_KEY | An API key issued by the upstream TTS provider you are calling |
How caching applies
Caching runs before the gateway forwards your request, so a cache hit never reaches the upstream provider:- Cache hit: the cached audio is returned and no provider billing event is generated.
- Cache miss: the request is sent upstream with your key, the provider bills your account, and the response is cached for future requests.
Supported providers
Send a BYOK request
AddX-Slng-Provider-Key to your TTS request alongside your standard SLNG Authorization header.
HTTP
WebSocket
SetX-Slng-Provider-Key as a header on the WebSocket upgrade request. The message flow after the upgrade is unchanged.
The browser WebSocket API does not support custom headers. Set the provider key from a server-side WebSocket client.
Error handling
HTTP
If the upstream provider rejects your key, the gateway returns the provider’s error response with this header:WebSocket
Auth failures surface as a WebSocket error frame after the upgrade is accepted, for examplebackend_connection_failed, with the upstream 401 or 403 detail included.