On this page
On this page
API Reference
Complete reference for the Proventra API endpoints
Complete documentation for all Proventra API endpoints.
Authentication
All API requests must include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Endpoints
Analyze Text
POST /api/v1/analyze
Analyzes text for potential prompt injection or jailbreak attempts.
Request Body
{
"text": string, // Required: Text to analyze
"sanitize": boolean // Optional: Whether to return sanitized text (default: false)
}
Response
{
"unsafe": boolean, // Whether the text contains potential threats
"sanitized": string // Present only if sanitize=true and the text was sanitized successfully
}
Example Request
curl -X POST https://api.proventra.com/api/v1/analyze \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"text": "Your text here",
"sanitize": true
}'
Rate Limits
We implement rate limiting to ensure fair usage of the API:
Tier | Monthly Limit | Rate Limit |
---|---|---|
Free | 500 requests | 100/minute |
Builder | Custom | Custom |
Contact us at team@proventra-ai.com to upgrade to a Builder tier for higher limits and custom configurations.
Next Steps
- See code examples for implementation details
- Check out our quick start guide to get started
- Learn about how it works