The Foxy Audit SDK manual

What is inside

This manual is for version 1.18.0 of the foxy-audit package. It works with Python 3.9 to 3.13. The rules that check your prompts are ruleset 2026.09.3.

The manual has five parts. Read them in order the first time. Each part builds on the one before it.

• Part 1 says what Foxy Audit is, in plain words.
• Part 2 gets a small program working in about ten minutes.
• Part 3 has one lesson for each feature.
• Part 4 shows how it works inside, for the curious.
• Part 5 helps when something goes wrong.

Every lesson has the same shape. It starts with what you will learn. Then come numbered steps, with code you can copy. When a step prints something, the lesson shows the exact output to expect. Each lesson ends with a table for when things go wrong.

The path through it

1. 1

   Part 1: Start here

   What Foxy Audit is, what the SDK does and does not do, and the words it uses.

   • Start here
   • Glossary
2. 2

   Part 2: Your first 10 minutes

   Install it, run it with no account, then connect it and check the proof.

   • Your first 10 minutes
3. 3

   Part 3: Lessons

   One feature per chapter, each with steps, code to copy and the output to expect.

   • The decorator and the client
   • Modes: observe, block and redact
   • Policies and rules
   • Response scanning
   • The spool and delivery
   • The foxy command
   • Configuration
   • Proving a row with foxy explain
   • The testbed
4. 4

   Part 4: For the curious

   What goes over the wire, how the proof works, and every name in the package.

   • The wire format
   • The evidence model
   • API reference
   • The rule catalogue
5. 5

   Part 5: Help

   Fixes for common problems, short answers, and how to install and upgrade.

   • Troubleshooting
   • Questions and answers
   • Installing and upgrading

Before you start

You need a computer with Python on it, and a terminal. A terminal is the window where you type commands. On Windows it is PowerShell. On a Mac it is the Terminal app.

You do not need an account for the first steps. The SDK works on your own machine first. You connect it to Foxy Audit later, in Part 2.

Three things we promise, and three we do not

We promise these:

• Your prompts and answers never go to Foxy Audit. Only hashes, counts and short labels do. Your prompts still go to your model provider, as they always did.
• Every record is kept in a chain. A change to an old record shows when you check the chain against a head you kept, or against an anchor on a public blockchain, where your workspace has one.
• You can check the chain yourself, with a free tool, without trusting us.

We do not promise these:

• The checks that run on your machine are measured, not guaranteed. They can miss a risky prompt.
• Foxy Audit gives you evidence. It does not certify your company or make it compliant.
• The manual cannot see your code. Test your own program before you trust it with real data.