Quick Start
Get started with GuardCrow in just a few minutes. This guide will walk you through making your first API request.
1
Get your API Key
First, you'll need an API key. Sign up or log in to your dashboard, create a project, and generate an API key.
2
Make your first request
Use cURL or any HTTP client to send a POST request to the analyze endpoint:
Terminalbash
curl -X POST https://api.guardcrow.com/v1/analyze \-H "X-API-Key: YOUR_API_KEY" \-H "Content-Type: application/json" \-d '{"content": "This is a test message to analyze"}'
3
Handle the response
The API returns a JSON response with the analysis results:
response.jsonjson
{"passed": true,"score": 1,"sentiment": "neutral","description": "Content is safe. No harmful elements detected.","categories": [],"processingTimeMs": 142}
Understanding the Response
| Field | Description |
|---|---|
| passed | true if content is safe, false if flagged |
| score | Toxicity score from 0 (safe) to 10 (highly toxic) |
| sentiment | Detected sentiment: positive, negative, neutral, or toxic |
| description | Human-readable explanation of the analysis |