Skip to content
ZushZush Docs

BYOK Setup for AI File Renaming

BYOK means Bring Your Own Key. It lets users on every Zush plan connect their own AI provider key for cloud renaming with Google AI (Gemini), Groq, OpenAI, or Anthropic.

Use BYOK when you want Zush’s desktop workflow, review screen, Templates, Naming Blocks, Monitor, and undo history, but you prefer to pay your own AI provider directly instead of relying only on the managed Zush provider.

Cloud BYOK settings in the Zush BYOK/Offline tab.
Choose a provider and paste its API key in the Cloud (BYOK) section. Save and Test appear when they are relevant.

What BYOK changes

Section titled “What BYOK changes”

With BYOK enabled, Zush still handles the file workflow:

  • add files or monitor a folder
  • extract the analysis payload Zush needs for renaming
  • call the selected AI provider through the BYOK flow
  • generate filenames, tags, and metadata
  • show previews before manual batches are applied
  • keep rename history so you can undo later

The main difference is the provider and billing path. Your AI provider bills usage under its current API pricing and account limits. Check the provider’s pricing, quota, and model permissions before running a very large batch.

Supported providers

Section titled “Supported providers”
Provider in ZushDashboardNotes
Google AIGoogle AI StudioUses the Gemini API
GroqGroq ConsoleUses compatible models available to your Groq project
OpenAIOpenAI PlatformUses compatible analysis models available to your OpenAI project
AnthropicAnthropic ConsoleUses compatible Claude models available to your Anthropic account

Zush loads compatible models after the key is saved. The default model is controlled by current Zush configuration, so the guide does not pin you to a model name that may later change.

Set up BYOK

Section titled “Set up BYOK”
  1. Open your provider dashboard: Google AI Studio, Groq Console, OpenAI Platform, or Anthropic Console.
  2. Create a new API key and copy it. Most providers show the full key only once.
  3. Open Zush and select BYOK/Offline in the sidebar.
  4. In Cloud (BYOK), choose the AI provider.
  5. Paste the API key.
  6. Click Save. Saving a valid key turns on Cloud BYOK automatically.
  7. Wait for the compatible model list to load. Keep the current default or choose another available model.
  8. Click Test to confirm the selected key and model work.
  9. Confirm the Cloud (BYOK) switch is on.
  10. Run a small batch before using BYOK on a large folder or monitored workflow.

Provider-specific steps

Section titled “Provider-specific steps”

Gemini

Section titled “Gemini”
  1. Open Google AI Studio.
  2. Create an API key.
  3. In Zush, choose Google AI as the AI Provider.
  4. Paste the key and click Save. Choose an available model if needed, then run Test.

Groq

Section titled “Groq”
  1. Open Groq Console.
  2. Create an API key.
  3. In Zush, choose Groq as the AI Provider.
  4. Paste the key and click Save. Choose an available model if needed, then run Test.

OpenAI

Section titled “OpenAI”
  1. Open OpenAI Platform API keys.
  2. Create a new secret key.
  3. In Zush, choose OpenAI as the AI Provider.
  4. Paste the key and click Save. Choose an available model if needed, then run Test.

Claude

Section titled “Claude”
  1. Open Anthropic Console keys.
  2. Create a key.
  3. In Zush, choose Anthropic as the AI Provider.
  4. Paste the key and click Save. Choose an available model if needed, then run Test.

Test before automation

Section titled “Test before automation”

After BYOK is saved, run a small manual batch rename first. Check that filenames are accurate, the provider does not reject requests, and the cost profile makes sense for your files.

Once the test batch looks right, you can use the same AI setup with Templates and folder monitoring.

Troubleshooting

Section titled “Troubleshooting”
ProblemWhat to check
Test failsConfirm the key was copied correctly and belongs to the selected provider
Provider rejects requestsCheck provider billing, free-tier limits, rate limits, or account verification
Results differ from Zush CloudDifferent providers and models can describe files differently; test with real files before automating
Costs are higher than expectedReview provider pricing and test with representative batches before monitoring large folders

Security and privacy

Section titled “Security and privacy”

Your API key is stored locally in secure platform storage. Zush can send it directly to the selected provider to load compatible models and run Test. It is also sent transiently to Zush backend when BYOK is enabled and when BYOK analysis is processed; the backend forwards analysis requests to the provider. Zush does not permanently store the key or retain file content after normal processing.

For local model processing instead of cloud provider processing, use Offline AI with Ollama.

Section titled “Related docs”