Spaces:
Configuration error
Configuration error
File size: 2,985 Bytes
122f90e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# LLMGuardian API Documentation
## Base URL
`https://api.llmguardian.com/v1` # replace llmguardian.com with your domain
## Authentication
Bearer token required in Authorization header:
```
Authorization: Bearer <your_token>
```
## Endpoints
### Security Scan
`POST /scan`
Scans content for security violations.
**Request:**
```json
{
"content": "string",
"context": {
"source": "string",
"user_id": "string"
},
"security_level": "medium"
}
```
**Response:**
```json
{
"is_safe": true,
"risk_level": "low",
"violations": [
{
"type": "string",
"description": "string",
"location": "string"
}
],
"recommendations": [
"string"
],
"metadata": {
"timestamp": "2024-01-01T00:00:00Z"
}
}
```
### Privacy Check
`POST /privacy/check`
Checks content for privacy violations.
**Request:**
```json
{
"content": "string",
"privacy_level": "confidential",
"context": {
"department": "string",
"data_type": "string"
}
}
```
**Response:**
```json
{
"compliant": true,
"violations": [
{
"category": "PII",
"details": "string",
"severity": "high"
}
],
"modified_content": "string",
"metadata": {
"timestamp": "2024-01-01T00:00:00Z"
}
}
```
### Vector Scan
`POST /vectors/scan`
Scans vector embeddings for security issues.
**Request:**
```json
{
"vectors": [
[0.1, 0.2, 0.3]
],
"metadata": {
"model": "string",
"source": "string"
}
}
```
**Response:**
```json
{
"is_safe": true,
"vulnerabilities": [
{
"type": "poisoning",
"severity": "high",
"affected_indices": [1, 2, 3]
}
],
"recommendations": [
"string"
]
}
```
## Error Responses
```json
{
"detail": "Error message",
"error_code": "ERROR_CODE",
"timestamp": "2024-01-01T00:00:00Z"
}
```
## Rate Limiting
- 100 requests per minute per API key
- 429 Too Many Requests response when exceeded
## SDKs
```python
from llmguardian import Client
client = Client("<api_key>")
result = client.scan_content("text to scan")
```
## Examples
```python
# Security scan
response = requests.post(
"https://api.llmguardian.com/v1/scan", # replace llmguardian.com with your domain
headers={"Authorization": f"Bearer {token}"},
json={
"content": "sensitive text",
"security_level": "high"
}
)
# Privacy check with context
response = requests.post(
"https://api.llmguardian.com/v1/privacy/check",
headers={"Authorization": f"Bearer {token}"},
json={
"content": "text with PII",
"privacy_level": "restricted",
"context": {"department": "HR"}
}
)
```
## Webhook Events
```json
{
"event": "security_violation",
"data": {
"violation_type": "string",
"severity": "high",
"timestamp": "2024-01-01T00:00:00Z"
}
}
```
## API Status
Check status at: https://status.llmguardian.com # replace llmguardian.com with your domain
Rate limits and API metrics available in dashboard.
|