本文へスキップ

SourceFinder API

SourceFinder サービスの公開 OpenAPI リファレンスです。

Base URL

text
https://api.coinpost.ai/sourcefinder

認証方式

API キーを CP-X-API-KEY ヘッダーで送信します。

形式例:

text
CP-X-API-KEY: <your-api-key>

エンドポイント

  • GET /health — ヘルスチェック
  • POST /sources — 非同期ソース探索ジョブを送信
  • GET /sources/{id} — ソース探索ジョブのステータスまたは結果を取得
  • POST /entities/extractions — 非同期エンティティ抽出ジョブを送信
  • GET /entities/extractions/{id} — エンティティ抽出ジョブのステータスまたは結果を取得
  • GET /entities — 最近のタスクで観測されたエンティティ集計を一覧表示

リクエストの注意点

  • POST /sources では titlecontentsource_urls のうち少なくとも 1 つが必要です
  • 任意のリクエスト単位 LLM 上書きは llm 配下に指定します
  • collected_at は不完全または相対的な日付の参照時刻として利用できます
  • エンティティ抽出は planner LLM パスを実行するため非同期です。まず textPOST /entities/extractions を呼び出し、返された job_idGET /entities/extractions/{id} をポーリングします
  • ソース探索ジョブ ID とエンティティ抽出ジョブ ID は、それぞれ別の結果取得エンドポイントを使います

レスポンスの共通形

  • ジョブレスポンスは data フィールドにデータをラップします。/health はサービスメタデータを直接返します
  • エラーレスポンスは error とメッセージ文字列を返します
  • ジョブ結果には status フィールド(pendingprocessingcompletedfailed)が含まれます
  • 完了したソース探索結果には primary_sourcesoriginal_urls、メトリクス、truth_assessment が含まれる場合があります。完了したエンティティ抽出結果には entities が含まれます