Skip to main content
公開 API は、Failproof AI ダッシュボードのオリジン上の /v1 で提供されます。

​
キーの作成とリクエストの実行

  1. Administration → Keys を開き、Create key を選択して、インテグレーションに必要な最小限の権限プリセットを選びます。
  2. 必要な場合のみ個別の権限を追加し、キーを作成して、ワンタイムシークレットをコピーします。
  3. /v1/sessions にテストリクエストを送り、Keys ページでキーがアクティブなままであることを確認します。
  4. インテグレーションのオーナーが変わったときは、アクションメニューからキーをローテートまたは無効化します。 権限プリセットと個別権限が表示された新しい API キー作成ドロワー。
上図は作成ドロワーです。ワンタイムシークレットは create を選択した後にのみ表示されます。確認画面を閉じる前にコピーしてください。
キーは組織と権限セットにスコープされます。エンドポイントに必要な権限がないリクエストは 403 を返し、不足している権限を示します。

​
組織の選択

組織キーは自動的にその組織に対して動作します。インスタンススコープのキーは、リクエストごとに組織を選択できます：
Administration → Keys を開く前に、ダッシュボードヘッダーの組織切り替えツールを使用してください。そこで作成されたキーは選択された組織に属します。認証情報を自動化に組み込む前に、URL とキーの詳細で組織スラッグを確認してください。
現在のパス、パラメーター、権限要件、ステータスコードについては、このセクションの生成されたエンドポイントページを参照してください。この仕様はサーバーのルートアノテーションから生成され、/v1 ルーターに対して検証されています。 現在の仕様は、ルート・メソッド・パラメーター・権限・ステータスコードのカバレッジが完全です。一部のレスポンスボディは、サーバーが動的な JSON として構築しているため、意図的に型未定義のままになっています。レスポンススキーマのないエンドポイントに対して強く型付けされたクライアントを生成する前に、実際のレスポンスを確認してください。 JSON の書き込みには Content-Type: application/json を使用してください。401 は認証情報の欠落または無効、403 は有効な認証情報だが必要な権限が不足、404 はリソースが存在しないか組織からアクセスできない、409 は状態の競合、422 はフィールドまたは権限の値が無効を意味します。エラーレスポンスには人が読めるメッセージが含まれ、権限エラーの場合は必要な権限も示されます。
ポリシー適用のデプロイメントは、通常の公開 /v1 サーフェスの外で意図的に管理されています。サポートされている Cloud デプロイメントワークフローを使用してください。