Veilfile

Docs

Quickstart

Sign up, verify your email, install the CLI, log in, and push your first file. Your workspace is provisioned automatically when you sign up. It takes about five minutes to go from signup to your first URL.

Three steps take you from signup to your first unguessable link.

1. Sign up and install the CLI

Sign up for an account. We email you a verification link. Click it. You cannot create an API key until your email is verified.

Install the veilfile command with pip, which needs Python 3.9 or later:

pip install veilfile

If you use Node 18.3 or later, you can run npm install -g veilfile instead. Install only one of the two, because both install a command named veilfile.

2. Log in

Run this command. It prints a web address and a code, then tries to open that page in your browser.

veilfile login

Check that the code on the page matches the one in your terminal, tick the confirmation box, and press Approve. The terminal receives its key within a few seconds. The code expires after 10 minutes and works once. If it expires, run veilfile login again.

If the browser does not open, open the printed address on any device and approve it there. The terminal keeps waiting until the code expires.

A login creates one API key, and keys made this way count toward your plan's key limit, the same as keys you create in the dashboard. Free allows one key, Team allows five keys, Team Plus allows ten keys, and Scale allows unlimited keys. At the limit, the approval page asks you to choose a key to replace, and anything still using that key stops working.

The CLI saves the key in a credentials file that only you can read. By default that file is ~/.config/veilfile/credentials on macOS and Linux, and %APPDATA%\veilfile\credentials on Windows. To print the stored key, run veilfile key. It prints the key and nothing else, so export VEILFILE_API_KEY=$(veilfile key) works as written. It does not confirm the key is still valid; run veilfile status for that.

3. Push

Replace screenshot.png with another file of an allowed type (see Limits below):

veilfile push screenshot.png

The command prints the share URL. Anyone who has the URL can open it in a browser with no login: the token in the URL is the auth.

The link expires when your plan's TTL runs out, which is seven days on Free. Pass --ttl-days 1 to shorten it. On a team, pass --visibility team to let your teammates see the file on their Files page, which works when your administrator lets each person decide.

Run veilfile logout when you are done with a machine. It revokes the key and deletes the credentials file, and the links you already made keep working until they expire. If that key is also exported as VEILFILE_API_KEY, logout leaves it unrevoked on the server and deletes the local copy only.

Next: connect an agent via MCP, or read how it works.

Manual fallback

When an agent needs its key in VEILFILE_API_KEY, print the stored key on the machine that already ran veilfile login and export it: export VEILFILE_API_KEY=$(veilfile key).

That is the same key the CLI uses. Nothing is revoked or re-created, and it works on Free, where the CLI key and the agent key are one key. A key saved by veilfile login stays in the credentials file, and the key-based MCP setups in the agent docs read VEILFILE_API_KEY instead.

Use the dashboard route below only on a machine without the CLI, or one that runs unattended, such as a CI runner.

Create an API key

On Free, which allows one key, first revoke the key from veilfile login, either in the dashboard or with veilfile logout.

Open the dashboard and create a key. It is shown exactly once. Copy it now.

Store the key as a secret in an environment variable or your secret manager. Your agent gets the variable name, VEILFILE_API_KEY. It never gets the value in a prompt.

Save it in your shell

Pick your shell. Replace PASTE_YOUR_KEY_HERE with the key, paste the line, press enter. It takes effect in this terminal at once.

bash · macOS · Linux
echo 'export VEILFILE_API_KEY="PASTE_YOUR_KEY_HERE"' >> ~/.bashrc && source ~/.bashrc

Upload with curl

With the variable set, this runs as written. Replace @screenshot.png with another file of an allowed type (see Limits below):

curl -X POST https://veilfile.com/api/v1/artifacts -H "Authorization: Bearer $VEILFILE_API_KEY" -F "file=@screenshot.png" -F "ttl_days=7"

A 201 comes back with id, url, expires_at, size_bytes, and secret_flags. Open the url in a browser. It works with no login. The token in the URL is the auth.

Then revoke it:

curl -X DELETE https://veilfile.com/api/v1/artifacts/<id> \
  -H "Authorization: Bearer $VEILFILE_API_KEY"

Replace <id> with the id from the upload. Success is a 204 with an empty body. The link returns 404 from that moment on.

Limits

  • One file is at most 25 MiB.
  • The allowed file types are png, jpg, jpeg, webp, gif, txt, md, log, json, har, and pdf.
  • Each API key or connected app can make 100 uploads per hour.
  • Each plan has a monthly upload quota and a hard storage cap. An upload that would exceed the storage cap fails with 402 storage_cap_reached. See how it works for the full table.

Prices include tax. The price you see is the price you pay. Free costs $0, Team costs $4 a month, Team Plus costs $6 a month, and Scale costs $12 a month. Billed yearly, Team costs $40 a year, Team Plus costs $60 a year, and Scale costs $120 a year, which is ten months' price. See Plans for the full table.