Skip to content
Farkitect
🤷

Forgive us! These docs are a work in progress. Some pages may be incomplete or describe features that aren't quite finished yet. Farkitect is in early development and we don't recommend using it for real work just yet. Feel free to explore — just be aware that things are still being built.

How to set up FarkiBot

FarkiBot is Farkitect’s built-in AI assistant. It answers questions about your models, writes documents from them, generates new metamodels and models, and rewrites models you already have.

FarkiBot works on a bring-your-own-key (BYOK) basis: you supply an API key for the AI provider of your choice, and Farkitect uses it on your behalf. There is nothing to buy from us, and no AI subscription bundled into Farkitect.

The privacy promise: your API key and your model content are sent directly from your browser to your chosen provider. Farkitect’s servers are never in the path — and you can verify that yourself in your browser’s network inspector. See How FarkiBot Works for why it’s built this way.

1. Open FarkiBot

Section titled “1. Open FarkiBot”

Choose View > FarkiBot (Ctrl+Shift+K). The panel opens alongside Properties, Context, and Notes.

The first time you open it, FarkiBot has no key and shows a Set up FarkiBot… button. You can reach the same settings at any time from the gear icon in the FarkiBot toolbar.

2. Choose a provider

Section titled “2. Choose a provider”

One key is the whole setup. Paste an OpenRouter key and you have every model — GPT, Claude, Gemini, Kimi, DeepSeek, Llama and 300+ more — behind a single credential. Signup is free, no card is required to start, and there are free models you can use at $0.

That’s the recommended path, and for most people it’s the only one they need.

Already pay another provider?

Section titled “Already pay another provider?”

You do not need a second card. Add your existing Anthropic, OpenAI, or Google key inside OpenRouter > Settings > BYOK. Those models then bill to your existing account at your existing rate limits, while FarkiBot still holds only the one OpenRouter key.

The Advanced options

Section titled “The Advanced options”

Under Advanced are direct provider connections, for two narrower cases:

Advanced optionWhen you actually need it
Anthropic / Google GeminiYou want that provider reached directly, with OpenRouter out of the path entirely. This is the stronger privacy posture — the answer when a client or a security review asks who sees your model content. It is not needed merely to use Claude or Gemini.
Custom endpointAny OpenAI-compatible base URL — local models via Ollama or LM Studio, or your organisation’s internal LLM gateway.

If you already have a direct provider configured, the Advanced section opens by itself so your key stays in plain sight.

There is no direct OpenAI option. OpenAI’s API does not permit browser connections, so it can’t be reached the way the others are. Add your OpenAI key inside OpenRouter > Settings > BYOK instead: GPT usage bills to your existing OpenAI account, and the same OpenRouter key still gets you every other model. Note that OpenAI API accounts hold no conversational history — that lives in ChatGPT, a separate product — so nothing is “left behind” by routing through OpenRouter.

3. Create a capped key

Section titled “3. Create a capped key”

Whatever provider you choose, create a dedicated key with a spend limit for FarkiBot. Then the worst case of any mishap is a cap you set yourself.

  • OpenRouter — create the key under Keys and set a credit limit (say $10, reset daily). Buying about $10 of credits once also unlocks 1,000 free-model requests per day. Skip auto-top-up: a fixed balance is a hard ceiling.
  • Anthropic — set a workspace spend limit in the console.

This is a five-minute step that makes every later decision reversible. Do it.

4. Paste and test

Section titled “4. Paste and test”

Paste the key into FarkiBot Settings. It’s masked from the moment you paste it, and after saving only the last 4 characters ever display — there’s no reveal button, by design.

Click Test connection to confirm the key works before you rely on it.

5. Decide how the key is stored

Section titled “5. Decide how the key is stored”
OptionBehaviour
Session only (default)The key lives in memory and disappears when the tab closes. Paste it again next session.
Remember on this browserThe key is persisted, encrypted (AES-256) with a key your browser holds internally that no website code — including Farkitect’s — can export.

It is never stored in the clear. Anyone inspecting this browser’s storage sees only ciphertext.

The honest caveat: no browser or desktop app can protect a secret from malicious code running as the app itself. Farkitect’s defences for that case are a strict Content-Security-Policy — a stolen key would have nowhere to be sent, because the browser refuses connections to any host not on the allow-list — and the capped key you created in step 3.

Where settings live

Section titled “Where settings live”

FarkiBot settings are per browser, per device. They’re stored locally, not on your Farkitect account, so:

  • Setting up FarkiBot on your laptop does not set it up on your desktop
  • Your key is never synced to Farkitect’s servers, because it never reaches them
  • Colleagues on the same project each bring their own key

Next steps

Section titled “Next steps”