jevfieldnotes
← LEARN

Set up a TypeSafe API key

Where to get a key, where to store it and how to check that your process can read it.

2 MIN READ · UPDATED 20 SEP 2026

Use the TypeSafe dashboard

Follow the dashboard link in the official quick start. You need credentials for TypeSafe’s Jev service. An account for the unrelated Akka/Typesafe product will not work.

Set the variable where the request runs

For a local command, export TYPESAFE_API_KEY in that terminal. For a deployed server, add it in the hosting service’s secret settings. A variable in your laptop terminal is not automatically present on the deployed server.

Check presence without displaying the secret

Run the check below in the same environment as your application. True means the variable is present, not that the provider accepts the key. Restart an already-running server after changing its environment.

python -c "import os; print(bool(os.getenv('TYPESAFE_API_KEY')))"

Send a small request

Use the first-request guide to confirm access. If you receive 401, inspect the authentication setup. If you receive another status, retain the status and error body; changing the key may have nothing to do with the problem.

Request example

export TYPESAFE_API_KEY="your-key"
# Keep .env files outside version control.