メインコンテンツへスキップ
準備状況レポートAPIは、組織のエージェント準備状況評価データへプログラムからアクセスする手段を提供します。

認証

すべてのリクエストにはAuthorizationヘッダーにFactory APIキーが必要です:
APIキーはapp.factory.ai/settings/api-keysで生成してください。

ベースURL


エンドポイント

準備状況レポートの一覧取得

組織の準備状況レポートを取得します。

クエリパラメータ

パラメータ必須説明
repoIdstringいいえリポジトリIDでレポートをフィルタ
limitintegerいいえ返すレポートの最大数(正の値である必要があります)
startAfterstringいいえページネーションカーソル用のレポートID

レスポンス

リクエスト例


準備状況レポートスキーマ

レポートオブジェクト

フィールド説明
reportIdstringレポートの一意識別子(UUID)
createdAtnumberレポートが作成されたUnixタイムスタンプ(ミリ秒)
repoUrlstring評価されたリポジトリURL
appsobjectアプリケーションパスから説明オブジェクトへのマップ
reportobject基準IDから評価結果へのマップ
commitHashstring?評価時のGitコミットハッシュ
branchstring?評価時のGitブランチ名
hasLocalChangesboolean?コミットされていない変更が存在したかどうか
hasNonRemoteCommitsboolean?プッシュされていないコミットが存在したかどうか
modelUsedobject?評価に使用されたモデル設定
droidVersionstring?レポートを生成したCLIバージョン

アプリ説明オブジェクト

フィールド説明
descriptionstringアプリケーションの機能に関する簡潔な説明

基準評価オブジェクト

フィールド説明
numeratornumber基準を満たしたサブアプリケーションの数(0からdenominatorまで)
denominatornumber基準が評価されたサブアプリケーションの数(最低1)
rationalestring評価結果の説明

使用モデルオブジェクト

フィールド説明
idstringモデル識別子
reasoningEffortstring推論労力レベル(lowmediumhighoff

ページネーション

大きな結果セットに対しては、カーソルベースのページネーションを使用してください:
  1. 希望するlimitで初回リクエストを実行
  2. レスポンスの最後のアイテムのreportIdを取得
  3. そのIDを次のリクエストでstartAfterとして渡す

使用例

CI/CD統合

各評価後にレポートを取得することで、時系列での準備状況スコアを追跡:

カスタムダッシュボード

すべてのレポートを取得し、集約メトリクスを計算することで内部ダッシュボードを構築:

自動アラート

準備状況スコアが閾値を下回った際のアラートを設定:

エラーレスポンス

ステータス説明
400無効なリクエストパラメータ
401APIキーが欠如または無効
500内部サーバーエラー