> ## 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.

# SMLTP 정책

> 모든 SMLTP 보안 정책 검색

# SMLTP 정책

사용 가능한 모든 SMLTP(Secure Model Language Transfer Protocol) 보안 정책을 검색합니다.

## 엔드포인트

```
GET /smltp-policies/all
```

## 설명

기본 제공 정책과 사용자 지정 정책을 포함하여 사용 가능한 모든 SMLTP 정책을 검색합니다. **관리자 전용 액세스가 필요합니다.**

## 인증

**필수**: 관리자 권한이 있는 API 키

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

## 쿼리 매개변수

| 매개변수                                              | 유형 | 필수 | 설명 |
| ------------------------------------------------- | -- | -- | -- |
| ❌ 쿼리 매개변수가 지원되지 않습니다. 실제 API는 쿼리 매개변수를 허용하지 않습니다. |    |    |    |

## 요청 예시

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

## 성공 응답

**상태 코드**: `200 OK`

```json theme={null}
{
  "success": true,
  "data": {
    "builtInPolicies": [
      {
        "id": "public",
        "name": "Public",
        "type": "built-in",
        "description": "For public, non-sensitive data",
        "isActive": false
      },
      {
        "id": "internal",
        "name": "Internal", 
        "type": "built-in",
        "description": "For internal company data",
        "isActive": true
      },
      {
        "id": "confidential",
        "name": "Confidential",
        "type": "built-in", 
        "description": "For confidential business data",
        "isActive": false
      },
      {
        "id": "hipaa",
        "name": "HIPAA",
        "type": "built-in",
        "description": "For healthcare data compliance", 
        "isActive": false
      },
      {
        "id": "gdpr",
        "name": "GDPR",
        "type": "built-in",
        "description": "For European data protection compliance",
        "isActive": false
      },
      {
        "id": "pci-dss", 
        "name": "PCI-DSS",
        "type": "built-in",
        "description": "For payment card industry compliance",
        "isActive": false
      }
    ],
    "customPolicies": [],
    "activePolicyTemplate": "internal",
    "summary": {
      "totalPolicies": 7,
      "builtInCount": 7,
      "customCount": 0
    }
  }
}
```

### 응답 필드

| 필드                           | 유형  | 설명                  |
| ---------------------------- | --- | ------------------- |
| `success`                    | 부울  | 작업이 성공했는지 여부를 나타냅니다 |
| `data`                       | 개체  | 응답 데이터 개체           |
| `data.builtInPolicies`       | 배열  | 기본 제공 정책 개체 배열      |
| `data.customPolicies`        | 배열  | 사용자 정의 정책 객체 배열     |
| `data.activePolicyTemplate`  | 문자열 | 현재 활성 정책 템플릿 ID     |
| `data.summary`               | 개체  | 요약통계                |
| `data.summary.totalPolicies` | 정수  | 총 정책 수              |
| `data.summary.builtInCount`  | 정수  | 기본 제공 정책 수          |
| `data.summary.customCount`   | 정수  | 사용자 정의 정책 수         |

## 사용 예

### 자바스크립트

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

// Example usage
const result = await getSmltpPolicies();
console.log('Built-in policies:', result.data.builtInPolicies);
console.log('Active policy:', result.data.activePolicyTemplate);
```

### 파이썬

```python theme={null}
import requests

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

# Example usage
result = get_smltp_policies()
print("Built-in policies:", result["data"]["builtInPolicies"])
print("Active policy:", result["data"]["activePolicyTemplate"])
```

### cURL

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

## 오류 응답

### 401 승인되지 않음

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

### 429 요청이 너무 많습니다.

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

## 정책 개체 필드

| 필드            | 유형  | 설명                         |
| ------------- | --- | -------------------------- |
| `id`          | 문자열 | 정책 식별자                     |
| `name`        | 문자열 | 정책 이름                      |
| `type`        | 문자열 | 정책 유형("기본 제공" 또는 "사용자 지정") |
| `description` | 문자열 | 정책 설명                      |
| `isActive`    | 부울  | 이 정책이 현재 활성화되어 있는지 여부      |
| `createdAt`   | 문자열 | 생성 타임스탬프(사용자 지정 정책에만 해당)   |

## 사용 사례

* **정책 검색**: 사용 가능한 보안 정책 찾기
* **규정 준수 계획**: 정책 요구 사항 이해
* **보안 구성**: 적절한 정책 선택
* **활성 정책 관리**: 현재 어떤 정책이 활성화되어 있는지 확인
* **통합**: 채팅 완료에 정책 적용

## 속도 제한

* **기본값**: 분당 요청 100개
* **일일**: 일일 요청 10,000건
* **월간**: 월간 요청 300,000건

## 메모

* 이 엔드포인트에는 관리자 권한이 필요합니다.
* 매개변수 없음: 쿼리 매개변수가 지원되지 않습니다.
* 내장 정책: 사전 정의된 시스템 정책을 반환합니다.
* 사용자 정의 정책: 사용자 정의 정책이 있는 경우 이를 반환합니다.
* 활성 정책: 현재 활성화된 정책 템플릿을 표시합니다.
* Flat Response: 응답이 데이터 개체 아래에 중첩됩니다.


## OpenAPI

````yaml GET /smltp-policies/all
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/all:
    get:
      tags:
        - SMLTP Security
      summary: Get All SMLTP Policies
      description: >
        Retrieve all available SMLTP policies including built-in and custom
        policies. Only accessible by administrators.
      responses:
        '200':
          description: All SMLTP policies
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      builtInPolicies:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: internal
                            name:
                              type: string
                              example: Internal
                            type:
                              type: string
                              enum:
                                - built-in
                                - custom
                              example: built-in
                            description:
                              type: string
                              example: For internal company data
                            isActive:
                              type: boolean
                              example: true
                      customPolicies:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: custom-policy
                            name:
                              type: string
                              example: Custom Policy
                            type:
                              type: string
                              enum:
                                - built-in
                                - custom
                              example: custom
                            description:
                              type: string
                              example: Custom SMLTP policy
                            isActive:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              format: date-time
                              example: '2024-01-15T10:30:00.000Z'
                      activePolicyTemplate:
                        type: string
                        example: internal
                      summary:
                        type: object
                        properties:
                          totalPolicies:
                            type: integer
                            example: 10
                          builtInCount:
                            type: integer
                            example: 7
                          customCount:
                            type: integer
                            example: 3
              example:
                success: true
                data:
                  builtInPolicies:
                    - id: public
                      name: Public
                      type: built-in
                      description: For public, non-sensitive data
                      isActive: false
                    - id: internal
                      name: Internal
                      type: built-in
                      description: For internal company data
                      isActive: true
                  customPolicies:
                    - id: custom-policy
                      name: Custom Policy
                      type: custom
                      description: Custom SMLTP policy
                      isActive: false
                      createdAt: '2024-01-15T10:30:00.000Z'
                  activePolicyTemplate: internal
                  summary:
                    totalPolicies: 10
                    builtInCount: 7
                    customCount: 3
        '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`

````