Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
Claude Code / Codex で始めるドキュメントマップsf CLI をインストールデータ・API・CLIの現況クイックスタートCLI 接続設定会社IDの見方初日の進め方Data Provenance
認証請求認証設定利用プランCLI
CLI 概要CLI 認証基本コマンド会社検索観測データ検索会社・観測・開示開示の表示・比較リスト・調査・クレジットヘルプとエラーコマンドとフラグCLI 更新
APIキーのライフサイクル利用量の計測提供中の機能
会社検索とプロフィール観測データ検索チームワークスペース会社の観測データ開示と比較APIキー管理UIリストワークスペース外部調査とクレジットSkills / CLI / API
Credit Schedule利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラートラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意credit と maxCredits の失敗estimate と materialize の失敗
概要

Data Capability Map

Signal Foundry で実際に利用できる data source、filter、API、CLI surface を、実装と `sf data capabilities --json` ベースで確認するためのページです。

このページの内容13項目
Status の読み方Current Data SourcesCurrent FiltersCompany SearchList DefinitionObservation SearchCurrent CLI SurfaceCurrent API SurfaceCompany / EvidenceList WorkspaceSource / Research / ControlCredit Boundary古い記述に当たった場合

このページは、古くなりやすい surface の確認場所です。docs の文章より、まず実行中の CLI と API が返す contract を優先します。

最初に必ず次を実行してください。

sf version --json --check-update
sf auth show --json
sf data capabilities --json

確認する key:

  • version
  • update.update_available
  • effectiveBaseUrl
  • effectiveApiKeyPreview
  • configPath
  • contract_version
  • capabilities[].source_id
  • capabilities[].status
  • capabilities[].filters[]
  • capabilities[].entrypoints[]
  • capabilities[].pricing
  • capabilities[].limitations[]
  • deferred_surfaces[]

2026-05-06 時点で確認した CLI は 0.2.18、capability contract は 2026-05-01 です。ただし、このページの固定値を正本にせず、実行時の sf data capabilities --json を正本にしてください。

Status の読み方

Status扱い
supported通常 workflow で使える。保存や credit 消費前は estimate / preview を見る
availablepublic surface として使える
partial範囲や coverage gap を説明してから使う
weak0 件成功にしない。根拠の弱さを人間に返す
unsupported実行しない。代替条件か follow-up に切る
planned / deferred現在の public workflow の前提にしない
needs_human保存、外部調査、credit 消費に進まない

Current Data Sources

SourceStatus使えること主な filter / entrypoint注意
company_mastersupported / availablecanonical company、identifier、profile を読むcompany_id, corporate_number, listing_status, market_segment, industry_33_code, website_domain, has_website; companies search, company profilecompany API だけを product 定義にしない
company_registrysupported / partial日本企業 universe の探索、地域・業種・規模・Web有無の粗い絞り込みprefecture, city, industry_keywords, business_keywords, employee_number, capital_stock, date_of_establishment, registry_status, source_flagssource of truth ではない。保存前に materialize / evidence 確認へ進む
user_imported_sourcesupported / availableCSV / 外部 source row を company に正規化するsf source import/inspect/map/resolve/review/select, sf list create --from-sourcemultiple_candidates は agent が勝手に確定しない
edinet_financial_factssupported / availableEDINET 財務指標で会社群を絞るmetric_key, metric_scope, relative_year, revenue_threshold, operating_income_threshold, ordinary_income_threshold, profit_before_tax_threshold, net_income_threshold, total_assets_threshold, net_assets_threshold指標は revenue, operating_income, ordinary_income, profit_before_tax, net_income, total_assets, net_assets
listing_eventssupported / available上場イベント、上場日、市場区分で絞るevent_type, listing_date, market_segment, exchange, source_idJPX / TOKYO PRO 中心。地方取引所は coverage gap として扱う
observationsweak / partialテーマ語の横断 evidence を探すsource, type, subtype, industry, market_segment, technology, website_domain, has_websitegenerative_ai, genai, llm, ai_agent は technology alias として使える
edinet_text_sectionsweak / partialEDINET 本文 section の bounded searchsection_key, document_type, theme_textテーマ探索は evidence 確認用。保存条件は supported filter に戻す
list_workspacesupported / availableestimate、saved List、refresh、diff、export、review の workspaceestimate_id, list_id, status, refresh_cadence, diff_statuspreview は saved List ではない
website_enrichmentsupported / partialsaved List row に公式サイト由来の column / evidence を足すsf list enrich <listId> --source website --estimate/--executefound row だけ課金対象。not_found / no_data は課金対象外
parallel_external_adapterweak / live_available_with_keynarrowed saved List の外部補完sf list enrich <listId> --source parallel --estimate --limit <n>broad search / Find All の入口にしない
external_researchsupported / availablecompany に紐づく補助調査 item を保存・一覧するcompany_id, list_id, source_type, promotion_status; sf research add/lscanonical observation への自動 promotion は含めない
jobsunsupported / plannedqueue / runtime job surfaceなしsf job ... CLI と job artifact は使えるが、汎用 jobs API は planned
newsunsupported / plannednews sourceなし代替として research item に明示保存する

Deferred surface は mcp、openapi_generation、large_agent_runtime です。docs や agent prompt では、これらを現行 product core として前提にしないでください。

Current Filters

Company Search

GET /api/signal-foundry/companies と sf companies search で使う主な条件:

FilterNotes
q証券コード、社名、corporate number、domain など
limit / offsetlimit は 1..100
listing_statuslisted, delisted, unknown
market_segment[]market segment の複数指定
industry_33_code[]JPX 33 業種コード
has_websitetrue / false

List Definition

saved List の definition で使う主な条件:

AreaFields
company filterscompany_ids, has_website, listing_status, market_segment, q
observation filterscompany_ids, has_website, industries, market_segments, observation_subtypes, observation_types, sources, technologies, website_domains, query
materializationlimit, monitored_signals, observations_per_company, scan_limit, selected_columns
schedule / status`refreshCadence: manual

Observation Search

POST /api/signal-foundry/observations/search と sf observations search は、テーマ語と構造 filter を分けます。

FieldNotes
query短いテーマ語。長い自然文条件を入れない
filters.company_ids会社を固定する場合
filters.sourcesEDINET / website など source を明示
filters.technologiesgenerative_ai, genai, llm, ai_agent など
limit1..100
observations_per_company1..20
scan_limit最大 10000

Current CLI Surface

Family役割
auth setup/init/showbase URL と API key の設定確認
agent installCodex / Claude Code skill の配置
versionCLI version と更新確認
data capabilitiessource / filter / pricing / limitation の正本
job business-understanding/company-research/sales-list/watchlist-reviewagent-ready workflow artifact
job artifact ls/show保存済み job artifact の再開
list plan/estimate/candidates/materialize/enrichquery-start の保存・enrichment
list ls/show/preview/publish/export/refresh/diff/createsaved List の確認、snapshot、diff、export、source / explicit company 由来保存
discovery show/refine/materializeestimate 後の run を復元し、追加条件で絞り、保存する
source import/inspect/map/resolve/review/selectCSV / 外部 source の正規化
observations search複数社をまたぐ evidence search
research ls/addexternal research item の保存・一覧
credits balance/summarycredit 残高と ledger summary
companies searchcompany resolver
company profile/observations/filings1 社の深掘り
filing show/compareEDINET filing detail / compare
feedback create要望・不具合を要約して送る

細かい option は CLI help を正本にしてください。

sf --help
sf list --help
sf source --help
sf job --help
sf observations search --help

Current API Surface

HTTP API は、既存 backend や batch から組み込むときに使います。Claude Code / Codex からは先に CLI を使います。

Company / Evidence

  • GET /api/signal-foundry/companies
  • GET /api/signal-foundry/companies/{companyId}/profile
  • GET /api/signal-foundry/companies/{companyId}/observations
  • GET /api/signal-foundry/companies/{companyId}/filings
  • GET /api/signal-foundry/companies/{companyId}/filings/{filingId}
  • GET /api/signal-foundry/companies/{companyId}/filings/{filingId}/compare
  • POST /api/signal-foundry/observations/search

List Workspace

  • GET /api/signal-foundry/lists
  • POST /api/signal-foundry/lists
  • GET /api/signal-foundry/lists/{listId}
  • POST /api/signal-foundry/lists/estimate
  • GET /api/signal-foundry/lists/candidates
  • POST /api/signal-foundry/lists/materialize
  • GET /api/signal-foundry/lists/{listId}/preview
  • POST /api/signal-foundry/lists/{listId}/publish
  • POST /api/signal-foundry/lists/{listId}/refresh
  • GET /api/signal-foundry/lists/{listId}/diffs/latest
  • GET /api/signal-foundry/lists/{listId}/export
  • PATCH /api/signal-foundry/lists/{listId}/status
  • PATCH /api/signal-foundry/lists/{listId}/schedule
  • GET /api/signal-foundry/lists/{listId}/suppressions
  • PATCH /api/signal-foundry/lists/{listId}/suppressions
  • PATCH /api/signal-foundry/lists/{listId}/diff-rows/{diffRowId}/review
  • PATCH /api/signal-foundry/lists/{listId}/diff-rows/{diffRowId}/exclusion
  • GET /api/signal-foundry/lists/{listId}/workspace-preferences
  • PATCH /api/signal-foundry/lists/{listId}/workspace-preferences
  • PATCH /api/signal-foundry/lists/{listId}/delivery
  • POST /api/signal-foundry/lists/{listId}/deliver
  • POST /api/signal-foundry/lists/run-due-refreshes
  • POST /api/signal-foundry/lists/run-pending-deliveries
  • POST /api/signal-foundry/lists/{listId}/enrichments/estimate
  • POST /api/signal-foundry/lists/{listId}/enrichments/run

delivery は saved List に対する advanced handoff です。approval workflow、CRM 同期、full monitor / alert を自動で始める surface ではありません。

Source / Research / Control

  • POST /api/signal-foundry/sources/import
  • GET /api/signal-foundry/sources/{sourceId}/inspect
  • POST /api/signal-foundry/sources/{sourceId}/map
  • POST /api/signal-foundry/sources/{sourceId}/resolve
  • GET /api/signal-foundry/sources/{sourceId}/review
  • POST /api/signal-foundry/sources/{sourceId}/select
  • GET /api/signal-foundry/research/items
  • POST /api/signal-foundry/research/items
  • GET /api/signal-foundry/research/external
  • POST /api/signal-foundry/research/external/estimate
  • POST /api/signal-foundry/research/external/fetch
  • GET /api/signal-foundry/job-artifacts
  • POST /api/signal-foundry/job-artifacts
  • GET /api/signal-foundry/job-artifacts/{artifactId}
  • GET /api/signal-foundry/credits/balance
  • GET /api/signal-foundry/credits
  • GET /api/signal-foundry/usage/summary
  • GET /api/signal-foundry/usage/credits
  • POST /api/signal-foundry/feedback

Credit Boundary

操作Credit
companies search, profile, observations, filings通常は消費しない
list plan, list estimate, list candidates消費しない
list materialize --executesaved row の Basic credit
source resolve --executematched row の Basic credit
source select明示選択した row/company の Basic credit
list enrich --source website --executefound row の enrichment credit
list enrich --source parallel --execute実行対象 row / external adapter の credit
list export消費しない
credits balance, credits summary消費しない

credit-consuming write は、必ず --execute --max-credits <n> を付けます。HTTP API では execute: true と maxCredits / max_credits を付けます。

古い記述に当たった場合

このページや他の docs と、実行中の CLI / API response が矛盾する場合は、実行結果を優先してください。

  1. sf version --json --check-update で CLI version を確認する。
  2. sf data capabilities --json で対象 source と filter の status を確認する。
  3. sf <surface> --help で command option を確認する。
  4. weak / unsupported / needs_human の場合は、0 件成功として扱わず、条件を分け直す。
  5. それでも判断できない場合は、sf feedback create "<title>" --details "<body>" --json で要約を送る。

このページの内容

Status の読み方Current Data SourcesCurrent FiltersCompany SearchList DefinitionObservation SearchCurrent CLI SurfaceCurrent API SurfaceCompany / EvidenceList WorkspaceSource / Research / ControlCredit Boundary古い記述に当たった場合