Endpoint (APIエンドポイント)

エンドポイントとは

エンドポイント(終端点)とは、APIが公開する特定のURLであり、リソースまたはアクションを表します。各エンドポイントは、URLとHTTPメソッドを組み合わせて、実行可能な操作を正確に定義します。

エンドポイントの構造

エンドポイントは以下で構成されます:

• ベースURL: https://ailabsaudit.com/api/v1
• リソースパス: /clients、/audits/42/results
• HTTPメソッド: GET、POST、PUT、DELETE
• パラメータ: クエリ文字列(?page=1)またはパス(/clients/{id})

一般的な例

• GET /api/v1/clients — クライアント一覧の取得
• GET /api/v1/clients/42 — クライアント#42の詳細
• POST /api/v1/audits/launch — 監査の開始
• GET /api/v1/reports/15/download — レポートのダウンロード

AI Labs Auditのエンドポイント

AI Labs AuditのREST APIは、クライアント、監査、レポート、アクションプラン、アンケート、分析、モデル、アカウントの8グループに分類された104のエンドポイントを公開しています。完全なドキュメントはSwagger経由で利用可能です。