Get the keys our examples use

Rasa Developer Edition

RASA_LICENSE

Used by: All Rasa examples.

Open the provider account or key page.

1. Open the license request form and enter your details.
2. Submit the request and use the license value supplied by Rasa. Save it as RASA_LICENSE.

Cost: Developer Edition is free within its license limits. Check the license terms for your use.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

OpenAI

OPENAI_API_KEY

Used by: The three banking demos and GPT examples.

Open the provider account or key page.

1. Sign in to the API platform and select your project.
2. Open API keys, select Create new secret key, name it, and create it.
3. Copy the value when it is shown. Save it as OPENAI_API_KEY. Check that the project has API usage available.

Cost: API use is metered. Check your project balance, available credits, and model prices before running. A ChatGPT login alone is not an API key.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Deepgram

DEEPGRAM_API_KEY

Used by: The banking demos and many voice examples.

Open the provider account or key page.

1. Create an account or sign in to the console. Select the project used for the demo.
2. Open Settings, then API Keys. Choose Create a New API Key, enter its settings, and select Create Key.
3. Copy its value and save it as DEEPGRAM_API_KEY.

Cost: New accounts include trial credit. Usage after available credit is charged under your plan; check the console balance.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Anthropic / Claude API

ANTHROPIC_API_KEY

Used by: Claude banking, insurance, and retail examples.

Open the provider account or key page.

1. Sign in to the Claude Console and open the API keys page under Settings.
2. Select Create key, name it, choose an expiration and linked account, then create it.
3. Copy the key once and save it as ANTHROPIC_API_KEY.

Cost: API use is paid and metered. Check console credits and billing; a consumer chat subscription is not this key.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Google Gemini

GEMINI_API_KEY

Used by: Gemini insurance, healthcare, and retail examples.

Open the provider account or key page.

1. Sign in with your Google account and open AI Studio API keys.
2. Select Create API key. Select or create the project requested by the dialog.
3. Copy the generated key and save it as GEMINI_API_KEY.

Cost: A rate-limited free tier covers selected models. Paid project keys incur usage charges; check the selected project and model.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Rime

RIME_API_KEY

Used by: Rime voice examples and optional voice routing.

Open the provider account or key page.

1. Create an account or sign in to the Rime dashboard.
2. Open API Tokens in the dashboard, then create a token for this example.
3. Copy the token and save it as RIME_API_KEY.

Cost: A free plan includes a monthly allowance. Paid plans charge for usage; check the current allowance and rates.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Speechmatics

SPEECHMATICS_API_KEY

Used by: Speechmatics examples and optional voice routing.

Open the provider account or key page.

1. Create an account or sign in to the portal.
2. Open Settings, then API Keys. Create and name a key.
3. Copy it and save it as SPEECHMATICS_API_KEY.

Cost: Free usage and paid plans have different limits. Check the plan for the speech service selected by your example.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

DeepSeek

DEEPSEEK_API_KEY

Used by: DevCopilot contributor example.

Open the provider account or key page.

1. Sign in to the DeepSeek platform and open API keys.
2. Create a key for this example and copy its value.
3. Save it as DEEPSEEK_API_KEY. The DevCopilot container maps this to its OpenAI-compatible client.

Cost: Model calls are metered. Check your account balance and the selected model price.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Groq

GROQ_API_KEY

Used by: NourishHer and NoteVs contributor examples.

Open the provider account or key page.

1. Sign in to GroqCloud and open API Keys.
2. Select Create API Key, name it, and copy the generated value.
3. Save it as GROQ_API_KEY.

Cost: The free plan is rate limited. Paid usage requires a paid plan; check your account limits.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Mistral

MISTRAL_API_KEY

Used by: TerraEnergy contributor example.

Open the provider account or key page.

1. Sign in to Studio with an account that has API access and billing enabled.
2. Open API Keys, select New key, enter a name and expiration, and create it.
3. Copy the key and save it as MISTRAL_API_KEY.

Cost: API access requires billing activation and pay-as-you-go. Check the console for account-specific offers.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

NVIDIA Build

NVIDIA_API_KEY

Used by: Skill evaluation contributor example.

Open the provider account or key page.

1. Sign in with an NVIDIA Developer Program account and open the selected model page.
2. Choose Get API Key and generate a key. Copy it when shown.
3. Save it as NVIDIA_API_KEY.

Cost: Eligible developer accounts can prototype on free hosted endpoints. Availability and quotas depend on the account and model.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Langfuse

LANGFUSE_PUBLIC_KEY and LANGFUSE_SECRET_KEY

Used by: Coffee shop contributor example tracing.

Open the provider account or key page.

1. Sign in and create or select the Langfuse project in the region used by the example.
2. Open Project Settings, then API Keys, and choose Create new API keys.
3. Copy the public and secret values into their two separate Codespaces secrets. Keep the configured host in the same region.

Cost: A free Hobby plan has usage limits. Paid plans and extra usage have their own charges.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Slack

SLACK_BOT_TOKEN and SLACK_APP_TOKEN

Used by: DevCopilot contributor example channel.

Open the provider account or key page.

1. Create or select your Slack app in a workspace where you may install it.
2. Under OAuth & Permissions, add the bot scopes listed by the example, install the app, and copy the Bot User OAuth Token as SLACK_BOT_TOKEN.
3. Under Basic Information, open App-Level Tokens. Generate a token with connections:write and save it as SLACK_APP_TOKEN. Enable Socket Mode for the listener.

Cost: Workspace permissions and plan limits apply. Creating tokens does not grant a paid workspace plan.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

USDA FoodData Central

USDA_FDC_API_KEY

Used by: NourishHer contributor example nutrition lookup.

Open the provider account or key page.

1. Open FoodData Central and choose Get an API Key.
2. Complete the data.gov key request form and its email verification.
3. Save the issued key as USDA_FDC_API_KEY.

Cost: Public API access is free with request limits. A key can be temporarily blocked when its limit is exceeded.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

AssemblyAI

ASSEMBLYAI_API_KEY

Used by: Optional voice router provider.

Open the provider account or key page.

1. Create an account or sign in to the dashboard.
2. Open API Keys and select Create New API Key. Name the key and create it.
3. Copy its value and save it as ASSEMBLYAI_API_KEY only when selecting this provider.

Cost: New accounts have limited trial credit; usage after that requires a funded account.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

ElevenLabs

ELEVENLABS_API_KEY

Used by: Optional voice router provider.

Open the provider account or key page.

1. Create an account or sign in. Open Developers in the sidebar, then API Keys.
2. Create a key, name it, and enable only the features selected by the example.
3. Copy the full value when shown and save it as ELEVENLABS_API_KEY.

Cost: A free plan has a limited allowance. Speech generation can consume credits or require a paid plan.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Azure Speech

AZURE_SPEECH_API_KEY

Used by: Optional voice router setting.

Open the provider account or key page.

1. Sign in to an Azure subscription and create a Speech resource.
2. After deployment, choose Go to resource and open Keys and Endpoint.
3. Copy a resource key as AZURE_SPEECH_API_KEY. Keep its region and endpoint consistent with the selected configuration.

Cost: The F0 tier has quotas where available; Standard usage is billed. Creating an Azure subscription can require billing details.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Neuphonic

NEUPHONIC_API_KEY

Used by: TerraEnergy contributor example speech output.

Open the provider account or key page.

1. Create an account or sign in to the Playground.
2. Open API Keys in the left navigation and select Generate New API Key.
3. Copy the value once and save it as NEUPHONIC_API_KEY.

Cost: Free access and paid features depend on the selected plan. Check the account allowance before running.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Copernicus Climate Data Store

CDS_API_KEY

Used by: TerraEnergy optional ERA5 weather data.

Open the provider account or key page.

1. Register or sign in to the Climate Data Store.
2. Open the official CDSAPI setup page while signed in and find your personal access token.
3. Save the token as CDS_API_KEY. Accept each required dataset license on that dataset page.

Cost: Registration and data access are free under the dataset terms. Requests may wait in a queue; check this older example’s endpoint compatibility before a live download.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

NSRDB solar data

NSRDB_API_KEY

Used by: TerraEnergy optional solar data.

Open the provider account or key page.

1. Open the official developer key signup form.
2. Submit your contact details and complete any email verification.
3. Save the issued developer key as NSRDB_API_KEY.

Cost: Public developer access is free with rate limits. Use your own key rather than the heavily limited demonstration key.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

OpenRouter

OPENROUTER_API_KEY

Used by: Optional coffee shop evaluation simulator.

Open the provider account or key page.

1. Sign in and open API Keys in your account settings.
2. Create a key for the evaluation tool and set a credit limit where offered.
3. Copy it and save it as OPENROUTER_API_KEY.

Cost: Selected free models have request limits. Paid models use account credits; the example’s selected model may require funding.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Weights & Biases

WANDB_API_KEY

Used by: Optional skill evaluation tracking.

Open the provider account or key page.

1. Sign in to Weights & Biases in Forge. Select your organization from the profile menu.
2. Open the organization’s API Keys tab. Choose New key, enter a name, and choose Create.
3. Copy the whole key once and save it as WANDB_API_KEY. Older locked clients may not accept newer key formats; check the example before enabling tracking.

Cost: A Free plan has usage limits. Pro and Enterprise plans charge for their selected features and extra usage; check your organization’s plan.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Telegram

TELEGRAM_BOT_TOKEN

Used by: Optional retail loyalty channel; not enabled by default.

Open the provider account or key page.

1. Open Telegram and contact the verified BotFather account.
2. Send /newbot and follow the name and username prompts.
3. Save the issued token as TELEGRAM_BOT_TOKEN. Follow the example’s separate channel setup before using it.

Cost: Creating a bot is free. Hosting the bot and any optional paid Telegram features are separate.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

TypeSafe / Jev

TYPESAFE_API_KEY

Used by: Jev tutorial’s explicitly selected live worker.

Open the provider account or key page.

1. Create an account or sign in to the TypeSafe console. Select your organization.
2. Open API keys and create a key while the organization has available credits.
3. Copy it and save it as TYPESAFE_API_KEY. The default scripted worker does not need it.

Cost: The live API uses prepaid credits, without free or trial credits. Keep the tutorial’s scripted mode if you do not want paid calls.

Official setup instructions ·Plan, pricing, or usage limits ·Save the key in Codespaces

Optional Fiserv trial credentials

The Premier voice demo uses a local mock and needs none of these. Its optional manual trial reader needs all three:FISERV_BH_API_KEY_NAME, FISERV_BH_API_KEY, andFISERV_BH_API_SECRET.

1. Sign in or create an account in the Fiserv Developer Portal.
2. Open Workspaces and choose Add a new workspace. Enter a name and description, select Banking Hub as the product, and choose Create.
3. Open the workspace's Credentials tab. Save API key name, API key, and API secret as the three values above.

The official getting-started pagedescribes a trial on a shared Premier sandbox and a paid plan for a dedicated environment. Check the workspace's actual allowance before enabling the manual trial reader. Use the banking environment and credentials specified by your trial.

Credentials alone do not enable calls: follow the Premier README's separate call-budget instructions. The budget limits calls; it is not a provider key. The API specification ZIP is also a separate input.

Save the three values in Codespaces.

Other configuration names

Some framework tutorials also use RASA_PRO_LICENSE. This is the same Rasa license value, not a second license to buy. Follow the selected tutorial's mapping from RASA_LICENSE.

LOCAL_LLM_API_KEY belongs to your chosen local model server. There is no shared signup service for it. Use the local server's authentication settings; a placeholder is appropriate only when that example explicitly uses a local server without authentication.

CARTESIA_API_KEY and NEBIUS_API_KEY appear in general setup checks but are not selected by the shipped example configurations. You do not need them for those examples.

Save a personal Codespaces secret

Repeat these steps for each key your example requires. Use development environment secrets for Codespaces, rather than Actions secrets.

1. Sign in to GitHub and open Settings → Codespaces.
2. Under Secrets, choose New secret.
3. Enter the exact name from your example, such as OPENAI_API_KEY.
4. Paste only the value. Leave out the name, equals sign, and surrounding quotes.
5. Under Repository access, select RasaHQ/rasa-community-resources. If you use your own fork, select that repository instead.
6. Choose Add secret. Repeat for each required name.
7. Create your Codespace using the example's badge. If it is already running, stop and restart it to receive the values.

Checkpoint: the required names appear in your personal Codespaces secret list, with access to the repository you will use. GitHub hides their saved values. The example's setup check can report whether a value is present without printing it.

Keep values out of source files, chats, screenshots, and issues. If a key was exposed, revoke it in the provider account, create a replacement, update the Codespaces secret, and restart the Codespace.

See GitHub's secret-management instructionsand Codespaces billing. Stopping the application does not stop the Codespace. Stop or delete the Codespace when finished, after preserving work you need.