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

# すべてのインデックスをリストする

> 利用可能なナレッジベースのインデックスをすべて取得します

# すべてのインデックスをリストする

システム内で利用可能なすべてのナレッジ ベース インデックスの包括的なリストを取得します。

## エンドポイント

```
GET /indexes/all
```

## 説明

このエンドポイントは、SecureAI システムで利用可能なすべてのナレッジ ベース インデックスを返します。タイプ、ステータス、作成日、メタデータなど、各インデックスに関する詳細情報が提供されます。これは、利用可能なナレッジ ベースとその機能を発見するのに役立ちます。

## 認証

**必須**: API キー

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

## クエリパラメータ

| パラメータ       | タイプ | 必須  | 説明    |                                     |
| ----------- | --- | --- | ----- | ----------------------------------- |
| `page`      | 整数  | いいえ | 1     | ページネーションのページ番号                      |
| `limit`     | 整数  | いいえ | 50    | ページごとのインデックスの数 (1 ～ 100)            |
| `search`    | 文字列 | いいえ | -     | インデックス名または共有インデックス名の検索語             |
| `type`      | 文字列 | いいえ | -     | インデックス タイプ (個人、一般、グループ) でフィルタリング    |
| `status`    | 文字列 | いいえ | アクティブ | インデックスのステータスによるフィルター (アクティブ、削除、すべて) |
| `sortBy`    | 文字列 | いいえ | 作成場所  | 並べ替えるフィールド                          |
| `sortOrder` | 文字列 | いいえ | 説明    | ソート順 (昇順、降順)                        |

## リクエストの例

```bash theme={null}
GET /indexes/all?type=personal&limit=20&page=1
```

## 成功の応答

**ステータス コード**: `200 OK`

```json theme={null}
{
  "success": true,
  "indexes": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "my-knowledge-base",
      "sharedIndexName": "my-knowledge-base",
      "namespace": "user-namespace",
      "type": "personal",
      "assignedUser": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "assignedGroup": null,
      "userId": "60a7c8f5e8b4f5001f7a8c24",
      "isActive": true,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "deletedAt": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 150,
    "pages": 3
  }
}
```

### 応答フィールド

| フィールド                       | タイプ    | 説明                        |
| --------------------------- | ------ | ------------------------- |
| `success`                   | ブール値   | 操作が成功したかどうかを示します。         |
| `indexes[]`                 | 配列     | インデックス オブジェクトの配列          |
| `indexes[].id`              | 文字列    | 一意のインデックス識別子              |
| `indexes[].name`            | 文字列    | インデックス名                   |
| `indexes[].sharedIndexName` | 文字列    | 共有インデックス名                 |
| `indexes[].namespace`       | 文字列    | インデックス名前空間                |
| `indexes[].type`            | 文字列    | インデックスの種類 (個人、一般、グループ、不明) |
| `indexes[].assignedUser`    | オブジェクト | 割り当てられたユーザー情報 (個人の場合)     |
| `indexes[].assignedGroup`   | オブジェクト | 割り当てられたグループ情報 (グループの場合)   |
| `indexes[].userId`          | 文字列    | ユーザーID                    |
| `indexes[].isActive`        | ブール値   | インデックスがアクティブかどうか          |
| `indexes[].createdAt`       | 文字列    | 作成タイムスタンプ                 |
| `indexes[].updatedAt`       | 文字列    | 最終更新タイムスタンプ               |
| `indexes[].deletedAt`       | 文字列    | 削除タイムスタンプ (削除された場合)       |
| `pagination`                | オブジェクト | ページネーション情報                |

## インデックスの種類

| タイプ        | 説明              | アクセス        |
| ---------- | --------------- | ----------- |
| `personal` | ユーザー作成の個人インデックス | 所有者のフルアクセス  |
| `general`  | 共有組織インデックス      | 権限によって異なります |
| `group`    | グループ割り当てインデックス  | グループメンバー    |
| `unknown`  | 割り当てが不明瞭なインデックス | さまざま        |

## インデックスのステータス

| ステータス     | 説明                      |
| --------- | ----------------------- |
| `active`  | インデックスは使用可能です           |
| `deleted` | インデックスが削除されました          |
| `all`     | アクティブなものと削除されたものの両方を含める |

## 使用例

### JavaScript

```javascript theme={null}
const listIndexes = async (params = {}) => {
  const queryString = new URLSearchParams(params).toString();
  const url = `https://{customer.name}.hiperai.ai/api/external/indexes/all${queryString ? `?${queryString}` : ''}`;
  
  const response = await fetch(url, {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here'
    }
  });
  
  return await response.json();
};

// Example usage
const result = await listIndexes({
  type: 'personal',
  limit: 10,
  page: 1
});
console.log(result.indexes);
```

### パイソン

```python theme={null}
import requests

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

# Example usage
params = {
    "type": "personal",
    "limit": 10,
    "page": 1
}

result = list_indexes(params)
print(result["indexes"])
```

### cURL

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes/all?type=personal&limit=10&page=1" \
  -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
  }
}
```

## フィルタリングの例

### タイプによるフィルター

```bash theme={null}
# Get only personal indexes
GET /indexes/all?type=personal

# Get only group indexes
GET /indexes/all?type=group
```

### ステータスによるフィルター

```bash theme={null}
# Get only active indexes
GET /indexes/all?status=active

# Get deleted indexes
GET /indexes/all?status=deleted
```

### ページネーション

```bash theme={null}
# Get first 20 indexes
GET /indexes/all?limit=20&page=1

# Get next 20 indexes
GET /indexes/all?limit=20&page=2
```

## 使用例

* **ディスカバリー**: RAG 操作に利用可能なナレッジ ベースを検索します。
* **管理**: 管理目的のリストインデックス
* **統合**: アプリケーション統合のためのインデックスを検出します
* **監視**: インデックスのステータスとメタデータを確認します
* **フィルタリング**: 特定の種類のインデックス (システム、個人など) を検索します。

## レート制限

* **デフォルト**: 1 分あたり 100 リクエスト
* **毎日**: 1 日あたり 10,000 リクエスト
* **毎月**: 毎月 300,000 件のリクエスト

## 注意事項

* このエンドポイントには管理者のみがアクセスできます
* 個人インデックスはその所有者のみに表示されます
* グループインデックスはグループメンバーに表示されます
* 応答には、割り当てられたユーザーとグループの情報が含まれます
* ページネーションではオフセットではなくページパラメータを使用します
* タイプとステータスによるフィルタリングは、結果を絞り込むのに役立ちます


## OpenAPI

````yaml GET /indexes/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:
  /indexes/all:
    get:
      tags:
        - Index Management
      summary: Get All Indexes
      description: >
        Retrieve all indexes (both user and group indexes) with pagination and
        filtering. Only accessible by administrators.
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          description: Number of indexes per page
          required: false
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 100
        - name: search
          in: query
          description: Search term for index name or shared index name
          required: false
          schema:
            type: string
        - name: type
          in: query
          description: Filter by index type
          required: false
          schema:
            type: string
            enum:
              - personal
              - general
              - group
        - name: status
          in: query
          description: Filter by index status
          required: false
          schema:
            type: string
            enum:
              - active
              - deleted
              - all
            default: active
      responses:
        '200':
          description: List of all indexes
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  indexes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 60a7c8f5e8b4f5001f7a8c23
                        name:
                          type: string
                          example: my-knowledge-base
                        sharedIndexName:
                          type: string
                          example: my-knowledge-base
                        namespace:
                          type: string
                          example: user-namespace
                        type:
                          type: string
                          enum:
                            - personal
                            - general
                            - group
                            - unknown
                          example: personal
                        assignedUser:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              example: 60a7c8f5e8b4f5001f7a8c24
                            name:
                              type: string
                              example: John Doe
                            email:
                              type: string
                              example: john@example.com
                        assignedGroup:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              example: 60a7c8f5e8b4f5001f7a8c25
                            name:
                              type: string
                              example: Engineering Team
                        userId:
                          type: string
                          example: 60a7c8f5e8b4f5001f7a8c24
                        isActive:
                          type: boolean
                          example: true
                        createdAt:
                          type: string
                          format: date-time
                          example: '2024-01-01T00:00:00.000Z'
                        updatedAt:
                          type: string
                          format: date-time
                          example: '2024-01-15T10:30:00.000Z'
                        deletedAt:
                          type: string
                          format: date-time
                          nullable: true
                          example: null
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        example: 1
                      limit:
                        type: integer
                        example: 50
                      total:
                        type: integer
                        example: 150
                      pages:
                        type: integer
                        example: 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`

````