NULTRA / SCAN LOCALLY BEFORE YOU SEND
NULTRA
Start free
DOCUMENTATION

Build with NULTRA.

Version 1 API reference. All cloud endpoints require a hashed API key and available credits.

Getting started

  1. Create an account and sign in.
  2. Use the 10 trial credits; purchase more when onchain billing is available.
  3. Create an API key in API Keys. The secret is shown once.
  4. Send a server-side request with Authorization: Bearer nu_live_....

Endpoints

POST /api/v1/scan detects categories, severity, location, and explanations.

POST /api/v1/redact adds sanitized_content.

POST /api/v1/firewall/evaluate returns an advisory allow, warn, redact, or block decision.

GET /api/v1/usage and GET /api/v1/events return account-specific metadata. Download OpenAPI specification.

curl -X POST https://YOUR_DOMAIN/api/v1/scan \ -H "Authorization: Bearer nu_live_YOUR_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{"content":"Contact alex@example.com"}'

Errors and limits

Content is limited to 50,000 characters. Errors return {"error":{"code":"...","message":"..."}}. Invalid keys return 401; insufficient credits return 402; reused idempotency keys return 409.

Privacy

Raw API content is processed for the request and is not saved in security events. Do not include secrets in URLs or headers other than the API key. The AI explanation feature sends only rule metadata to OpenAI after explicit consent.