Get Available Knowledge Bases

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/indexes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/indexes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "indexes": [
    {
      "id": "Zero-Knowledge",
      "name": "Zero-Knowledge",
      "type": "system",
      "description": "Direct AI responses without knowledge base retrieval"
    },
    {
      "id": "my-knowledge-base",
      "name": "my-knowledge-base",
      "type": "personal",
      "namespace": "user-namespace"
    }
  ],
  "restrictions": {
    "allowed_indexes": "all user indexes"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

GET

indexes

Get Available Knowledge Bases

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/indexes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/indexes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "indexes": [
    {
      "id": "Zero-Knowledge",
      "name": "Zero-Knowledge",
      "type": "system",
      "description": "Direct AI responses without knowledge base retrieval"
    },
    {
      "id": "my-knowledge-base",
      "name": "my-knowledge-base",
      "type": "personal",
      "namespace": "user-namespace"
    }
  ],
  "restrictions": {
    "allowed_indexes": "all user indexes"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

利用可能なナレッジベースを取得する

API キーがアクセスできる利用可能なナレッジベース (インデックス) を取得します。

エンドポイント

GET /indexes

説明

API キーがアクセスできる利用可能なナレッジベース (インデックス) を取得します。個人インデックス、共有インデックス、およびゼロ知識オプションが含まれます。

認証

必須: API キー

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

リクエスト

curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here"

応答

成功の応答 (200)

{
  "success": true,
  "indexes": [
    {
      "id": "Zero-Knowledge",
      "name": "Zero-Knowledge",
      "type": "system",
      "description": "Direct AI responses without knowledge base retrieval"
    },
    {
      "id": "my-knowledge-base",
      "name": "my-knowledge-base",
      "type": "personal",
      "namespace": "user-namespace"
    }
  ],
  "restrictions": {
    "allowed_indexes": "all user indexes"
  }
}

応答フィールド

フィールド	タイプ	説明	例
`success`	ブール値	リクエストが成功した場合は常に true	`true`
`indexes`	配列	利用可能なナレッジベースのリスト	例を参照
`restrictions`	オブジェクト	インデックスのアクセス制限	例を参照

インデックスオブジェクト

フィールド	タイプ	説明	例
`id`	文字列	一意のインデックス識別子	`"my-knowledge-base"`
`name`	文字列	インデックス表示名	`"my-knowledge-base"`
`type`	文字列	インデックスの種類	`"personal"`
`namespace`	文字列	インデックス名前空間 (オプション)	`"user-namespace"`
`description`	文字列	インデックスの説明 (オプション)	`"Direct AI responses..."`

インデックスの種類

タイプ	説明
`system`	システム提供のインデックス (例: Zero-Knowledge)
`personal`	ユーザーの個人的な知識ベース
`general`	共有知識ベース

制限対象

フィールド	タイプ	説明	例
`allowed_indexes`	文字列	許可されるインデックスの説明	`"all user indexes"`

エラー応答

401 不正

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

使用例

JavaScript/Node.js

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/indexes', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();
console.log('Available Indexes:', data.indexes);

パイソン

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/indexes', headers=headers)
data = response.json()

print('Available Indexes:', data['indexes'])

cURL

curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here"

特別なインデックス

知識ゼロ

Zero-Knowledge インデックスは、ナレッジベースを取得せずに直接 AI 応答を提供する特別なシステムインデックスです。次の場合にこれを使用します。

RAG を使用しない純粋な AI 応答
AI モデルの機能をテストする
特定の文脈のない一般的な会話

注意事項

ゼロ知識インデックスはいつでも利用可能です
個人インデックスはユーザーによって作成されます
インデックスへのアクセスは権限に応じて異なります
チャット完了リクエストでインデックス ID を使用する

承認

Authorization

string

header

必須

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

レスポンス

List of available knowledge bases

success

boolean

例:

true

indexes

object[]

Show child attributes

restrictions

object

Show child attributes

導入 & セットアップ

モデル & AI 生成

ナレッジベース & RAG

セキュリティ、ガードレール & 監査

ユーザー & アクセス (IAM)

請求、クォータ & Webhook

利用可能なナレッジベース

利用可能なナレッジベースを取得する

エンドポイント

説明

認証

リクエスト

応答

成功の応答 (200)

応答フィールド

インデックスオブジェクト

インデックスの種類

制限対象

エラー応答

401 不正

使用例

JavaScript/Node.js

パイソン

cURL

特別なインデックス

知識ゼロ

注意事項

承認

レスポンス

​利用可能なナレッジベースを取得する

​エンドポイント

​説明

​認証

​リクエスト

​応答

​成功の応答 (200)

​応答フィールド

​インデックスオブジェクト

​インデックスの種類

​制限対象

​エラー応答

​401 不正

​使用例

​JavaScript/Node.js

​パイソン

​cURL

​特別なインデックス

​知識ゼロ

​注意事項

承認

レスポンス

利用可能なナレッジベースを取得する

エンドポイント

説明

認証

リクエスト

応答

成功の応答 (200)

応答フィールド

インデックスオブジェクト

インデックスの種類

制限対象

エラー応答

401 不正

使用例

JavaScript/Node.js

パイソン

cURL

特別なインデックス

知識ゼロ

注意事項