> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aktive SMLTP-Richtlinien

> Rufen Sie aktuell aktive SMLTP-Richtlinien ab

# Aktive SMLTP-Richtlinien

Rufen Sie die aktuell aktiven SMLTP-Richtlinien (Secure Model Language Transfer Protocol) für Ihr Konto ab.

## Endpunkt

```
GET /smltp-policies/active
```

## Beschreibung

Rufen Sie die aktuell aktive SMLTP-Richtlinienkonfiguration ab. **Nur Administratorzugriff erforderlich.**

## Authentifizierung

**Erforderlich**: API-Schlüssel mit Administratorrechten

```
Authorization: Bearer sk-your-api-key-here
```

## Beispielanfrage

```bash theme={null}
GET /smltp-policies/active
```

## Erfolgsantwort

**Statuscode**: `200 OK`

```json theme={null}
{
  "success": true,
  "data": {
    "template": "internal",
    "policy": {
      // Current policy configuration object
    },
    "lastUpdated": "2024-01-15T10:30:00.000Z"
  }
}
```

### Antwortfelder

| Feld               | Geben Sie       | ein Beschreibung                          |
| ------------------ | --------------- | ----------------------------------------- |
| `success`          | boolescher Wert | Zeigt an, ob der Vorgang erfolgreich war  |
| `data`             | Objekt          | Antwortdatenobjekt                        |
| `data.template`    | Zeichenfolge    | Derzeit aktive Richtlinienvorlagen-ID     |
| `data.policy`      | Objekt          | Aktuelles Richtlinienkonfigurationsobjekt |
| `data.lastUpdated` | Zeichenfolge    | Zeitstempel der letzten Aktualisierung    |

## Beispielverwendung

### JavaScript

```javascript theme={null}
const getActiveSmltpPolicy = async () => {
  const response = await fetch('https://{customer.name}.hiperai.ai/api/external/smltp-policies/active', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here'
    }
  });
  
  return await response.json();
};

// Example usage
const result = await getActiveSmltpPolicy();
console.log('Active template:', result.data.template);
console.log('Policy config:', result.data.policy);
```

### Python

```python theme={null}
import requests

def get_active_smltp_policy():
    url = "https://{customer.name}.hiperai.ai/api/external/smltp-policies/active"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here"
    }
    
    response = requests.get(url, headers=headers)
    return response.json()

# Example usage
result = get_active_smltp_policy()
print("Active template:", result["data"]["template"])
print("Policy config:", result["data"]["policy"])
```

### cURL

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/smltp-policies/active" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## Fehlerantworten

### 401 Nicht autorisiert

```json theme={null}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
```

### 429 Zu viele Anfragen

```json theme={null}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}
```

## Anwendungsfälle

* **Richtlinienüberprüfung**: Überprüfen Sie, welche Richtlinienvorlage derzeit aktiv ist
* **Konfigurationsprüfung**: Überprüfen Sie die aktuelle Richtlinienkonfiguration
* **Vorlagenverwaltung**: Verstehen Sie, welche Richtlinienvorlage verwendet wird
* **Fehlerbehebung**: Aktuelle Richtlinieneinstellungen verstehen
* **Audit-Vorbereitung**: Überprüfen Sie die aktive Richtlinie für Compliance-Audits

## Tarifbegrenzungen

* **Standard**: 100 Anfragen pro Minute
* **Täglich**: 10.000 Anfragen pro Tag
* **Monatlich**: 300.000 Anfragen pro Monat

## Notizen

– Für diesen Endpunkt sind Administratorrechte erforderlich

* Einzelne Richtlinie: Gibt die derzeit aktive Richtlinienvorlage und -konfiguration zurück
* Keine Arrays: Gibt kein Array von Richtlinien zurück, sondern nur die aktive
* Vorlagen-ID: Zeigt an, welche Richtlinienvorlage derzeit aktiv ist
* Richtlinienkonfiguration: Gibt das tatsächliche Richtlinienkonfigurationsobjekt zurück
* Verschachtelte Antwort: Die Antwort ist unter dem Datenobjekt verschachtelt


## OpenAPI

````yaml GET /smltp-policies/active
openapi: 3.0.3
info:
  title: SecureAI External API
  description: >
    SecureAI External API provides AI chat completion and image generation
    capabilities with knowledge base retrieval, 

    security policies, and comprehensive usage tracking. This API is designed
    for external developers 

    and integrations using API key authentication.


    ## Key Features

    - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge
    bases for relevant context

    - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI
    models

    - **Model Redundancy & Failover**: Caller-defined failover chains (primary +
    fallbacks) with per-attempt timeouts

    - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1`
    — no code changes

    - **Image Generation**: Generate and edit images using Google Gemini 2.5
    Flash Image

    - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI
    Realtime API with WebRTC

    - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield,
    and signed compliance receipts

    - **Usage Tracking**: Comprehensive usage monitoring, self-service quota,
    and rate limiting

    - **Knowledge Base Integration**: Access to personal and shared knowledge
    bases

    - **User Management**: Complete user, group, and role management
    capabilities

    - **Audit Logging**: Comprehensive activity and security audit logs


    ## Authentication

    All endpoints (except health check) require API key authentication using
    Bearer token:

    ```

    Authorization: Bearer sk-your-api-key-here

    ```


    ## Billing and Usage

    By default, API requests are billed to the user account that owns the API
    key. You can specify 

    a different user to bill by including the `user_id` parameter in your
    request. This allows for:

    - Multi-tenant applications with per-user billing

    - Flexible completion limit management

    - Per-user "Usage by Model" settings


    ## Rate Limits

    - Default: 60 requests per minute, 1000 requests per hour

    - Daily limits: 100 requests (configurable)

    - Monthly limits: 10,000 requests (configurable)


    ## Base URL

    ```

    https://secureai.hiperai.ai/api/external

    ```
  version: 1.1.0
  contact:
    name: SecureAI Support
    email: support@secureai.hiperai.ai
  license:
    name: Proprietary
    url: https://secureai.hiperai.ai/terms
servers:
  - url: https://secureai.hiperai.ai/api/external
    description: Production server
  - url: http://localhost:3010/api/external
    description: Development server
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: System health and status endpoints
  - name: Discovery
    description: Endpoints to discover available models, indexes, and policies
  - name: Chat
    description: AI chat completion endpoints
  - name: User Management
    description: Endpoints for managing user accounts and roles
  - name: Index Management
    description: Endpoints for managing knowledge base indexes
  - name: Group Management
    description: Endpoints for managing user groups
  - name: SMLTP Security
    description: Endpoints for managing SMLTP security policies and audit logs
  - name: Role Management
    description: Endpoints for managing user roles
  - name: Activity Logs
    description: Endpoints for retrieving activity logs
externalDocs:
  description: SecureAI Documentation
  url: https://secureai.hiperai.ai/docs
paths:
  /smltp-policies/active:
    get:
      tags:
        - SMLTP Security
      summary: Get Active SMLTP Policy
      description: >
        Retrieve the currently active SMLTP policy configuration. Only
        accessible by administrators.
      responses:
        '200':
          description: Active SMLTP policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      template:
                        type: string
                        example: internal
                      policy:
                        type: object
                        description: Current policy configuration object
                      lastUpdated:
                        type: string
                        format: date-time
                        example: '2024-01-15T10:30:00.000Z'
              example:
                success: true
                data:
                  template: internal
                  policy: null
                  lastUpdated: '2024-01-15T10:30:00.000Z'
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - admin only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid API key
        message:
          type: string
          example: The provided API key is invalid or has been revoked
        request_id:
          type: string
          example: req-abc123
          description: Request ID for tracking (if available)
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key authentication using Bearer token format.
        Example: `Authorization: Bearer sk-your-api-key-here`

````