What you need
Getting your API key
- Sign in to the Inworld Portal.
- Click API Keys in the bottom left sidebar.
- Click Generate new key.
- Copy the Basic (Base64) authorization signature.
Adding the connection
- Go to Connections and choose Inworld.
- Paste the API key.
- Save.
What you can select afterwards
Choose your model and voice on Model Configurations. Model — start with the flash variant on calls and move up only if the voice quality falls short on a real call. See Inworld’s TTS models page for the current line-up. Voice — a voice is referenced by name, for exampleDennis. Browse the stock, community and your own voices in the Voice Library, or audition them in the TTS Playground.
Custom voices — a cloned or designed voice is referenced by its own resource name; one published to the community library uses its public community- identifier.
Languages — BCP-47 codes, from broad codes like es through regional locales like es-MX. Some are marked experimental and vary more in pronunciation — check yours on Inworld’s language support page.
Completing the pipeline
Inworld drives voice only. You also need:- A language model to decide what the agent says
- A transcriber to turn caller speech into text
Troubleshooting
The key is rejected when I save
The key is rejected when I save
You most likely copied the raw key or the secret rather than the Basic (Base64) authorization signature. Return to API Keys in the Inworld Portal and copy that value. Also confirm the key is a Standard key — a Realtime-only key cannot drive text-to-speech, and a key’s type cannot be changed after it is created.
A voice I can hear in the portal is not found on a call
A voice I can hear in the portal is not found on a call
Cloned and designed voices belong to a single Inworld workspace, and a key only reaches the workspace it was generated in. Switch to that workspace in the portal, generate a key there, and update the connection. For a community voice, use its public
community- identifier rather than the display name.Calls worked and then stopped mid-month
Calls worked and then stopped mid-month
Inworld bills against a monthly credit balance shared across every product on the account, and text-to-speech is charged per character synthesized. Check the balance on the portal’s Billing page and top it up or enable auto-reload. A failed subscription payment also downgrades the account and disables API usage.
Some calls lose the voice under load
Some calls lose the voice under load
Inworld caps how many generations run at once per account, shared across all your API keys, and requests over the cap are rejected. The cap is set by your plan. If you run many simultaneous calls, raise the plan.