Back to Playlist · VidFarm Walkthrough Tutorial
Part 7 of 33Setup6 min read
Setup

Register & set up VidFarm

Create your account, grab your VidFarm API key, add your own AI provider keys, and install the agent skill — so you (or an AI agent) can drive VidFarm end-to-end. Every step with the real on-screen buttons.

Copies the whole guide — prompts, next steps & all — for your AI agent
Watch this chapter
The full first-run setup: signing in with an email code, copying the API key, adding an AI key, installing the vidfarm skill, and confirming with vidfarm whoami.

Key takeaways

  • There's no /register form — you register right on /login using an email one-time code.
  • Your VidFarm API key, your AI keys, and the agent skill all live on the single Settings → Developer tab.
  • Install the agent skill with one command: npx skills add https://github.com/officexapp/vidfarm.
  • Auth uses the vidfarm-api-key header (or VIDFARM_API_KEY for the CLI) — never Authorization: Bearer.

Step 1 — create your accountRegister (it's the login screen)

First surprise: there is no separate register page. Registration happens on /login through the email one-time-code flow — a first-time email that verifies a code becomes a new account. If you type /register, head to /login instead.

  1. Open the login screen

    Go to /login . The default mode is "Email code" (there's also a "Password" segment for later). The left panel is marketing — "A week of content, made in an afternoon." — and the right panel is the auth card.

  2. Request your login code

    Enter your Email and click "✉ Email me a login code". The card switches to "Check your email."

  3. Enter the code and your name

    Type the 6-digit code, then fill in "Your name (optional — for new accounts)" — this is the registration signal for a first-time email. Click "Verify & continue →". You're registered, signed in, and dropped on /settings.

The two-column login screen. Left: marketing panel with the VidFarm wordmark and H1 'A week of content, made in an afternoon.' Right: the 'Check your email' auth card with a 6-digit code input, a 'Your name (optional — for new accounts)' field, and a 'Verify & continue →' button. A segmented control at the top shows 'Email code' active next to 'Password'.
There's no /register form — you register here, on /login, with an email code. The optional name field is what turns a first-time login into a new account.
Note Prefer a password later? Flip the segmented control to "Password" to sign in with email + password once you've set one. The email-code path is the fastest first-run route.

Step 2 — Developer tabCopy your VidFarm API key

Everything an agent needs to authenticate is one key. It lives on the Developer tab — the same tab that holds your AI keys and the agent skill, so you'll do the next three steps without leaving this page.

  1. Go to Settings → Developer

    Open Settings → Developer . Settings has a left nav — Profile · Wallet · Channels · Developer, plus a separate Subscription link and a Log out.

  2. Reveal and copy the key

    In the "Your vidfarm API key" card, click the eye to reveal the key (optional), then click "Copy" — it flashes "Copied!". The field is read-only; you can only reveal and copy it.

  3. Store it for the CLI or REST

    Save it as VIDFARM_API_KEY for the vidfarm CLI, or send it as the vidfarm-api-key HTTP header for REST calls — never Authorization: Bearer.

The Settings Developer tab. Left nav shows Profile, Wallet, Channels, and a highlighted Developer. The main panel shows the 'Your vidfarm API key' card with a masked (password-style) key field, an eye reveal button, and an ink 'Copy' button, and below it the SKILL.md install pill.
Step 2 — the 'Your vidfarm API key' card on the Developer tab. Reveal with the eye, then Copy. The SKILL.md pill below is the agent-skill step.

Step 3 — BYOKAdd your own AI keys

Bring-your-own-key (BYOK) turns on the smart features and keeps costs near zero, because your keys are never billed by VidFarm. Same Developer tab, second card.

  1. Open "Bring your own AI Keys"

    On the same Developer tab , scroll to "Bring your own AI Keys" and click the gold "Add AI Key" button.

  2. Pick a provider and paste the key

    Choose a ProviderOpenAI, Gemini, or OpenRouter for full features; Nvidia (clipping only) or ElevenLabs (audio only) for the limited ones — add an optional Label, paste the API key, and click "Add AI key".

    Start with OpenAI or Gemini for the core features; the Nvidia and OpenRouter partnered free tiers keep costs near zero. Remember: Nvidia can't generate images or video, and ElevenLabs isn't a qualified AI key — always pair them with a full key.

The 'Add AI Key' dialog over the Developer tab. Provider dropdown expanded showing OpenAI, Gemini, OpenRouter, Nvidia (clipping only), and ElevenLabs (audio only), plus a Label field, a masked API key input with an eye reveal, and Close / gold 'Add AI key' buttons.
Step 3 — add a provider key. The dropdown spells out the limits so you don't mistake Nvidia (clipping-only) or ElevenLabs (audio-only) for full keys.
Tip Not sure which key does what, or which plan you need? The full breakdown of the five tiers is in Free vs paid & BYOK perks .

Step 4 — teach an AI to drive VidFarmInstall the agent skill

The last core step turns any capable coding agent into a VidFarm director. The skill is vidfarm, and it installs from GitHub with one command.

▤ Agent skill Install vidfarm

Copy the full REST + CLI playbook into your agent, or grab the one-line install command from the ⋮ menu.

  1. Open the install command

    On the Developer tab , find the SKILL.md pill (below the API key). Click the menu to open the "Install Command" popover and copy npx skills add https://github.com/officexapp/vidfarm. There's a "View GitHub" link there too.

  2. Install it into your agent

    Run that command in the project where your AI coding agent (Claude Code, Codex, etc.) lives. It pulls the vidfarm skill from GitHub so the agent gains VidFarm's operating knowledge — the three paintbrushes and the full REST/CLI playbook.

  3. Or copy the whole playbook

    No CLI handy? Click the SKILL.md pill itself to copy the entire playbook to your clipboard, then paste it into your agent's context. Finally, make sure VIDFARM_API_KEY (Step 2) is set so the agent can authenticate.

The SKILL.md install pill on the Developer tab with its ⋮ popover open, showing the 'Install Command' kicker, a read-only input pre-filled with 'npx skills add https://github.com/officexapp/vidfarm', a copy button, and a 'View GitHub' link.
Step 4 — the SKILL.md pill's Install Command popover. One click copies the command that teaches your agent how to drive VidFarm.
Note Two different install channels: the director skill comes from GitHub (npx skills add <github-url>); the craft sub-skills (hyperframes, media, captions) install from the VidFarm host via vidfarm skills add <name> — never from third-party registries.

Step 5 — finish the profileOptional — channels & product profile

Two optional steps make VidFarm work harder for you once the essentials are done:

The Settings left navigation showing all destinations: Profile, Wallet, Channels, Developer, a separated Subscription link, and a red Log out — so a reader can see where each setup step lives.
The Settings left nav. Register lands you here; the Developer tab holds Steps 2–4, while Channels and Profile cover the optional Step 5.

For devcli usersDo the whole setup from the terminal

Prefer the command line? This block runs the entire setup — install the skill, register via OTP, save the key, add a BYOK key, and confirm auth:

Full setup — copy & paste
npx skills add https://github.com/officexapp/vidfarm   # install the agent skill
vidfarm login you@studio.co                                     # request an OTP
vidfarm verify you@studio.co 123456                             # verify → prints your API key
export VIDFARM_API_KEY=<key>                                    # save it
vidfarm whoami                                                  # confirm auth works
vidfarm add-provider-key openai sk-...                          # bring your own key
vidfarm provider-keys                                           # list keys to confirm

Where to go next

You're set up. Now make something — start with the fastest end-to-end path, or the gentlest first edit:

Now make your first video

Account registered, API key copied, AI keys added, skill installed. Open the Discover feed, fork a template, and ship a short — cloud renders start at $0.01.

Open the Discover feed