Skip to main content
Methods:
  • [Web Browser] By default, your credentials are loaded through a quick exchange with https://usesynth.ai in your web browser.
  • [Local] Use setup --local to load your credentials through either files saved to your device or manual input.

​
Load from Web Browser

  • Loads to current process environment
  • Writes to .env in current working directory
  • Writes to config.json in your home directory, ~/.synth-ai/

​
In your terminal, run:

uvx synth-ai setup

​
Example usage:

beck@Jacobs-Laptop my-training % uvx synth-ai setup

🌐 Connecting to https://www.usesynth.ai to fetch your Synth credentials

✅ Connected to Jacob Roddy Beck's Stealth Startup

Loading SYNTH_API_KEY into process environment
Using SYNTH_API_KEY=sk-...068 from process environment
Wrote SYNTH_API_KEY=sk-...068 to /Users/beck/.synth-ai/config.json
Wrote SYNTH_API_KEY=sk-...068 to /Users/beck/my-training/.env

Loading ENVIRONMENT_API_KEY into process environment
Using ENVIRONMENT_API_KEY=sk-...419 from process environment
Wrote ENVIRONMENT_API_KEY=sk-...419 to /Users/beck/.synth-ai/config.json
Wrote ENVIRONMENT_API_KEY=sk-...419 to /Users/beck/my-training/.env

​
Load from Local Machine

  • Loads to current process environment
  • Writes nothing

​
In your terminal, run:

uvx synth-ai setup --local

​
Example usage:

beck@Jacobs-Laptop my-training % uvx synth-ai setup --local

Found the following options for SYNTH_API_KEY
 [1] (.env)  sk-...087
 [2] (sft/.env)  sk-...012
 [3] (rl/.env)  sk-...700
 [4] (/Users/beck/.synth-ai/config.json)  sk-...092
 [m] Enter value manually

Select option [1]: 4
Loaded SYNTH_API_KEY=sk-...092 into process environment

Found the following options for ENVIRONMENT_API_KEY
 [1] (.env)  sk-...110
 [2] (sft/.env)  sk-...808
 [3] (rl/.env)  sk-...434
 [4] (/Users/beck/.synth-ai/config.json)  sk-...956
 [m] Enter value manually

Select option [1]: 
Loaded ENVIRONMENT_API_KEY=sk-...110 into process environment