Loading...
ENTERPRISE API

Prompt Security API

Production-grade API for AI security scanning at scale

<100ms
Response Time
99.9%
Uptime SLA
10k/min
Rate Limit

Interactive API Tester

Response Ready
Click "Scan Prompt" to test the API

API Endpoints

POST /api/v1/scan

Scan a single prompt for security vulnerabilities

Request Example
curl -X POST /cyberseal6x/api/v1/scan \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "prompt": "Your prompt text here",
    "metadata": {
      "userId": "user123",
      "sessionId": "session456"
    }
  }'
Response Example
{
  "scanId": "scan_abc123",
  "timestamp": "2026-02-20T12:00:00Z",
  "riskScore": 85,
  "riskLevel": "HIGH",
  "threats": [
    {
      "type": "PROMPT_INJECTION",
      "severity": "HIGH",
      "confidence": 0.95,
      "description": "Detected instruction override attempt"
    }
  ],
  "recommendation": "Block this prompt"
}
POST /api/v1/scan/batch

Submit multiple prompts for batch scanning

Request Example
curl -X POST /cyberseal6x/api/v1/scan/batch \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "prompts": [
      {
        "id": "prompt1",
        "text": "First prompt to scan"
      },
      {
        "id": "prompt2",
        "text": "Second prompt to scan"
      }
    ]
  }'
Response Example
{
  "batchId": "batch_xyz789",
  "status": "PROCESSING",
  "totalPrompts": 2,
  "estimatedCompletionTime": "2026-02-20T12:05:00Z",
  "statusUrl": "/api/v1/scan/batch/batch_xyz789/results"
}
GET /api/v1/scan/batch/:batchId/results

Retrieve results for a batch scan

Request Example
curl -X GET /cyberseal6x/api/v1/scan/batch/batch_xyz789/results \
  -H "X-API-Key: your_api_key"
Response Example
{
  "batchId": "batch_xyz789",
  "status": "COMPLETED",
  "results": [
    {
      "id": "prompt1",
      "scanId": "scan_abc123",
      "riskScore": 25,
      "riskLevel": "LOW",
      "threats": []
    },
    {
      "id": "prompt2",
      "scanId": "scan_def456",
      "riskScore": 85,
      "riskLevel": "HIGH",
      "threats": [...]
    }
  ]
}
GET /api/v1/health

Check API health and service status

Response Example
{
  "status": "operational",
  "timestamp": "2026-02-20T12:00:00Z",
  "version": "1.0.0"
}

Authentication

All API requests require an API key passed in the X-API-Key header.

Authentication Header
X-API-Key: your_api_key_here
Security Best Practices
  • Never expose API keys in client-side code
  • Rotate keys regularly and immediately if compromised
  • Use environment variables for key storage
  • Implement rate limiting on your end

Rate Limits

Developer
100/min
For testing and development
Business
1,000/min
For production applications
Enterprise
10,000/min
For high-volume operations

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1645363200