Get Security Policies

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

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"
}

GET

smltp-policies

Get Security Policies

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

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"
}

セキュリティポリシーを取得する

利用可能な SMLTP (Secure Model Language Transfer Protocol) セキュリティポリシーを取得します。

エンドポイント

GET /smltp-policies

説明

利用可能な SMLTP (Secure Model Language Transfer Protocol) セキュリティポリシーを取得します。これらのポリシーは、データの処理方法と保護方法を決定します。

認証

必須: API キー

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

リクエスト

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

応答

成功の応答 (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"]
  }
}

応答フィールド

フィールド	タイプ	説明	例
`success`	ブール値	リクエストが成功した場合は常に true	`true`
`policies`	配列	利用可能なセキュリティポリシーのリスト	例を参照
`restrictions`	オブジェクト	ポリシーのアクセス制限	例を参照

ポリシーオブジェクト

フィールド	タイプ	説明	例
`id`	文字列	一意のポリシー識別子	`"internal"`
`name`	文字列	ポリシー表示名	`"Internal"`
`description`	文字列	ポリシーの説明	`"For internal company data"`

制限対象

フィールド	タイプ	説明	例
`allowed_policies`	配列	許可されたポリシー ID の配列	`["public", "internal", "confidential"]`

エラー応答

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/smltp-policies', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

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

パイソン

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"

ポリシーの種類

パブリック

ユースケース: 公開された非機密データ
セキュリティレベル: 低
データ処理: 基本的なセキュリティを備えた標準処理

内部

使用例: 社内データ
セキュリティレベル: 中
データ処理: 追加の保護手段によるセキュリティの強化

機密

ユースケース: 機密のビジネスデータ
セキュリティレベル: 高
データ処理: 厳密なデータ処理による最大限のセキュリティ

注意事項

データの機密性に基づいて適切なポリシーを選択します
ポリシーはデータの処理方法と保護方法に影響します
チャット完了リクエストでポリシー ID を使用する
一部のポリシーはアカウントの種類に基づいて制限される場合があります

承認

Authorization

string

header

必須

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

レスポンス

List of available security policies

success

boolean

例:

true

policies

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

ポリシーの種類

パブリック

内部

機密

注意事項