Get Security Policies
curl --request GET \
--url https://secureai.hiperai.ai/api/external/smltp-policies \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/smltp-policies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/smltp-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"policies": [
{
"id": "public",
"name": "Public",
"description": "For public, non-sensitive data"
},
{
"id": "internal",
"name": "Internal",
"description": "For internal company data"
},
{
"id": "confidential",
"name": "Confidential",
"description": "For confidential business data"
}
],
"restrictions": {
"allowed_policies": "all"
}
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}Sicherheit, Guardrails & Auditierung
Sicherheitsrichtlinien
Retrieve available SMLTP (Secure Multi-Layer Trust Protocol) security policies. These policies determine how your data is processed and protected.
GET
/
smltp-policies
Get Security Policies
curl --request GET \
--url https://secureai.hiperai.ai/api/external/smltp-policies \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/smltp-policies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/smltp-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"policies": [
{
"id": "public",
"name": "Public",
"description": "For public, non-sensitive data"
},
{
"id": "internal",
"name": "Internal",
"description": "For internal company data"
},
{
"id": "confidential",
"name": "Confidential",
"description": "For confidential business data"
}
],
"restrictions": {
"allowed_policies": "all"
}
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}Sicherheitsrichtlinien abrufen
Rufen Sie verfügbare SMLTP-Sicherheitsrichtlinien (Secure Model Language Transfer Protocol) ab.Endpunkt
GET /smltp-policies
Beschreibung
Rufen Sie verfügbare SMLTP-Sicherheitsrichtlinien (Secure Model Language Transfer Protocol) ab. Diese Richtlinien legen fest, wie Ihre Daten verarbeitet und geschützt werden.Authentifizierung
Erforderlich: API-SchlüsselAuthorization: Bearer sk-your-api-key-here
Anfrage
curl -X GET "https://{customer.name}.hiperai.ai/api/external/smltp-policies" \
-H "Authorization: Bearer sk-your-api-key-here"
Antwort
Erfolgsantwort (200)
{
"success": true,
"policies": [
{
"id": "public",
"name": "Public",
"description": "For public, non-sensitive data"
},
{
"id": "internal",
"name": "Internal",
"description": "For internal company data"
},
{
"id": "confidential",
"name": "Confidential",
"description": "For confidential business data"
}
],
"restrictions": {
"allowed_policies": ["public", "internal", "confidential"]
}
}
Antwortfelder
| Feld | Geben Sie | ein Beschreibung | Beispiel |
|---|---|---|---|
success | boolescher Wert | Bei erfolgreichen Anfragen immer wahr | true |
policies | Array | Liste der verfügbaren Sicherheitsrichtlinien | Siehe Beispiel |
restrictions | Objekt | Richtlinienzugriffsbeschränkungen | Siehe Beispiel |
Richtlinienobjekt
| Feld | Geben Sie | ein Beschreibung | Beispiel |
|---|---|---|---|
id | Zeichenfolge | Eindeutiger Richtlinienbezeichner | "internal" |
name | Zeichenfolge | Anzeigename der Richtlinie | "Internal" |
description | Zeichenfolge | Richtlinienbeschreibung | "For internal company data" |
Restrictions-Objekt
| Feld | Geben Sie | ein Beschreibung | Beispiel |
|---|---|---|---|
allowed_policies | Array | Array zulässiger Richtlinien-IDs | ["public", "internal", "confidential"] |
Fehlerantworten
401 Nicht autorisiert
{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked"
}
Beispielverwendung
JavaScript/Node.js
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/smltp-policies', {
headers: {
'Authorization': 'Bearer sk-your-api-key-here'
}
});
const data = await response.json();
console.log('Available Policies:', data.policies);
Python
import requests
headers = {
'Authorization': 'Bearer sk-your-api-key-here'
}
response = requests.get('https://{customer.name}.hiperai.ai/api/external/smltp-policies', headers=headers)
data = response.json()
print('Available Policies:', data['policies'])
cURL
curl -X GET "https://{customer.name}.hiperai.ai/api/external/smltp-policies" \
-H "Authorization: Bearer sk-your-api-key-here"
Richtlinientypen
Öffentlich
- Anwendungsfall: Öffentliche, nicht sensible Daten
- Sicherheitsstufe: Niedrig
- Datenverarbeitung: Standardverarbeitung mit grundlegender Sicherheit
Intern
- Anwendungsfall: Interne Unternehmensdaten
- Sicherheitsstufe: Mittel
- Datenverarbeitung: Erhöhte Sicherheit mit zusätzlichen Schutzmaßnahmen
Vertraulich
- Anwendungsfall: Vertrauliche Geschäftsdaten
- Sicherheitsstufe: Hoch
- Datenverarbeitung: Maximale Sicherheit bei strenger Datenverarbeitung
Notizen
- Wählen Sie die entsprechende Richtlinie basierend auf Ihrer Datensensibilität
- Richtlinien beeinflussen, wie Ihre Daten verarbeitet und geschützt werden
- Verwenden Sie die Richtlinien-ID in Chat-Abschlussanfragen
- Einige Richtlinien können je nach Kontotyp eingeschränkt sein
Autorisierungen
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here