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

API リファレンス

認証、利用上限、主要 endpoint を実行単位で確認します。

API 概要
OpenAPI Inventory会社検索会社プロフィール会社の観測データ開示一覧開示詳細開示比較観測データ検索ソースAPIリストAPIリスト見積もりリスト候補確認リスト保存リストEnrichmentリストExport調査アイテムクレジット残高クレジット利用サマリーフィードバックAPI外部調査API
API リファレンス

GET/POST /research/items

external research item を canonical company data と分離して保存・一覧する API contract です。

このページの内容10項目
契約サマリーリクエストGETPOSTレスポンスGET responsePOST responseエラー復旧方法現時点で含めないもの

/api/signal-foundry/research/items は、外部調査メモ、web search 結果、PDF 抽出結果などを external research artifact として保存する endpoint pair です。

research item は canonical company / observation を直接更新しません。canonical data に昇格させる候補は promotionStatus で示しますが、自動 promotion や review workflow はこの endpoint の範囲外です。

契約サマリー

EndpointPurposeAuthCreditCLI equivalent
GET /api/signal-foundry/research/items保存済み external research item を読むproduction は API key 必須消費しないsf research ls --json
POST /api/signal-foundry/research/itemscompany に紐づく external research item を保存するproduction は API key 必須保存自体は product credit を消費しないsf research add <companyId> --content "..." --json

現行 public contract では companyId が必須です。company-less / list-only research item は deferred surface なので、保存前に sf companies search <query> --json で canonical company_id を固定してください。

リクエスト

GET

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/research/items?company_id=jpx_7203&limit=20" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>"

CLI equivalent:

sf research ls --company-id jpx_7203 --json

クエリパラメータ:

ParamTypeDefaultNotes
company_idstringnullcanonical company_id
list_iduuidnulloptional list context
promotion_statusarray[]repeated parameter
source_typearray[]repeated parameter
limitinteger201..100

POST

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/research/items" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": "jpx_7203",
    "title": "IR note",
    "sourceType": "manual",
    "sourceUrl": "https://example.com/research-note",
    "contentMarkdown": "補助的な外部調査メモ",
    "promotionStatus": "session_only",
    "dedupeKey": "manual:jpx_7203:2026-05-01",
    "evidence": {
      "source": "manual review"
    }
  }'

CLI equivalent:

sf research add jpx_7203 --title "IR note" --content-file ./note.md --json

body fields:

FieldRequiredNotes
companyIdYescanonical company_id
contentMarkdownYes保存する external artifact 本文
sourceTypeYescrawl4ai web_search deep_search pdf_extract manual
titleNo人間向け title
sourceUrlNo外部 source URL。private URL は入れない
listIdNosaved List 文脈
promotionStatusNosession_only reusable canonical_candidate promoted
dedupeKeyNo同じ artifact の重複保存を避ける key
confidenceNo0..1
evidence / producer / structuredPayloadNoJSON object
observedAt / fetchedAtNoISO datetime

レスポンス

GET response

見る key:

  • items[]
  • items[].research_item_id
  • items[].company_id
  • items[].title
  • items[].source_type
  • items[].source_url
  • items[].promotion_status
  • items[].content_markdown
  • items[].dedupe_key
  • items[].evidence
  • items[].structured_payload
  • items[].fetched_at
  • meta.filters
  • meta.returned_items

POST response

見る key:

  • item.research_item_id
  • item.company_id
  • item.source_type
  • item.promotion_status
  • item.content_markdown
  • item.source_url
  • item.dedupe_key
  • meta.created

meta.created=false の場合は、同じ dedupeKey の item がすでに存在しています。

エラー

CodeStatus復旧
invalid_query400limit、filter、repeated parameter を schema に合わせる
invalid_request400companyId contentMarkdown sourceType を確認する
company_not_found404sf companies search <query> --json で canonical company_id を解決し直す
account_scope_conflict400API key 利用時は accountId を送らない
invalid_api_key401API key を再発行し、CLI なら sf auth setup をやり直す

復旧方法

canonical data と external research の境界を保つため、外部調査を保存しても observations[] や company profile は更新された前提にしないでください。

canonical へ採用したい場合は promotionStatus: "canonical_candidate" として保存し、別の review / import process に渡します。company に紐付けられない artifact は、この public endpoint ではなく follow-up として扱います。

現時点で含めないもの

  • queue / retry / schedule
  • canonical observation への自動 promotion
  • company-less research item
  • raw transcript や private URL の保存

このページの内容

契約サマリーリクエストGETPOSTレスポンスGET responsePOST responseエラー復旧方法現時点で含めないもの