Quickstart Guide

Get up and running with NSFWGuard in under 5 minutes. This guide walks you through generating an API key, making your first request, and interpreting the results.

Step 1: Get Your API Key

Navigate to your API Keys dashboard and click "Generate New Key". Your key will only be shown once — store it securely

Step 2: Make Your First Request

cURL
curl -X POST https://api.nsfwguard.com/classify \ -H "X-API-Key: YOUR_API_KEY" \ -F "image=@photo.jpg"

Step 3: Poll for Results

The classify endpoint returns a jobId. Poll the result endpoint to retrieve the classification:

cURL
curl https://api.nsfwguard.com/result/YOUR_JOB_ID

Pro Tip

Results are cached in Redis for 1 hour. For high-throughput applications, consider implementing a webhook callback instead of polling.