Skip to main content

1. Get an API key

Create an account, then open your dashboard and generate a key under API keys. The secret is shown once, so store it somewhere safe.

Get your API key

New accounts include free trial credits. No card required.

2. Make your first call

Pass your key in the X-Auth-Key header and the contract you want to check as query parameters.

3. Read the verdict

A safe contract returns an empty vulnerabilities array:
Every authenticated call also echoes a billing object next to audit: the tier that was charged and the credits it cost. See Credits & Billing. An unsafe one lists the risks it found:
Branch on isSafe for your decision, surface description to users, and read vulnerabilities for details. See Understanding Results.

Next steps

How to integrate

The recommended production pattern: fire-and-subscribe plus one SSE stream.

Authentication

Keys, headers, and key safety.

Audit a Contract

Full endpoint reference, every parameter and response.

Risk Categories

Every risk type we can return.

Credits & Billing

What a call costs.