Skip to main content
[ DOCS · QUICKSTART ]

Getting Started

ZERO TO FIRST SCAN · UNDER 5 MINUTES

1. Create an Account

Head to shieldpi.io/auth/register and sign up with your email. You will receive a verification email — click the link to activate your account. The free plan gives you 1 scan to try things out.

2. Add a Target

Navigate to Dashboard → Targets → Add Target. Fill in:

  • Name — a label for your own reference (e.g. "Production Chatbot")
  • Scan Mode — choose Browser, API, Agent, or Model
  • URL / Endpoint — the target URL or API endpoint

For Model mode, select a model from the dropdown — no URL needed. ShieldPi connects directly through OpenRouter.

3. Run Your First Scan

From the target detail page, click Start Scan. The scan runs asynchronously — you can close the tab and come back later. A typical model scan takes 10–30 minutes; browser and API scans are usually faster.

While the scan is running, the dashboard shows a live progress indicator with the current phase (fingerprinting, scout, amplify, deep dive, etc.).

4. Read the Results

Once complete, the scan detail page shows:

  • Security Score — 0–100 with a letter grade (A through F)
  • Vulnerability List — each finding with severity, category, and remediation
  • Intelligence Panel — detected model, defense profile, effective vs. failed attack categories

Download the report as PDF, JSON, CSV, Markdown, or HTML from the report dropdown.

Next Steps