OmniScout Docs

クラウドクイックスタート

数分でAPIキー、初回検索、初回回答、初回ブラウザセッションを体験します。

OmniScout Cloudはホスト型APIです:所有インデックス上の意味検索、根拠付き回答、Fly Sprite上のリモートブラウザ/コンピューターセッションです。ローカルCLIは変わりません — Cloudは追加分です。

1. APIキーを取得します

  1. api.omniscout.xyzでサインインします。
  2. Dashboard → API Keys → Create keyに進みます。値をコピーします — os_live_で始まり、初回のみ表示されます。
  3. エクスポートします:
export OMNISCOUT_API_KEY=os_live_YOUR_KEY
export OMNISCOUT_BASE_URL=https://api.omniscout.xyz

キーの仕組みと2つ目の資格情報(セッションシークレット)は認証をご覧ください。

2. 初回検索

curl -X POST $OMNISCOUT_BASE_URL/v0/search \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "rust async runtimes", "limit": 5}'

url、title、snippet、score、rank付きのランク済みヒットと、サポート用のrequest_idが返ります。エンドポイントをご覧ください。

3. 初回回答

curl -X POST $OMNISCOUT_BASE_URL/v0/answer \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "What is the latest stable Rust version?"}'

sourcesとconfidence付きのanswerが返ります — 根拠が薄い場合はanswerがnullのstatus: insufficient_informationになります。エンドポイントをご覧ください。

4. 初回ブラウザセッション

セッションはCLIと同じdaemonプリミティブをリモートSprite上で実行します。ライフサイクル:作成 → ポーリング → 操作 → 破棄です。

# Create (API key only) — save session_id AND session_secret
CREATE=$(curl -sS -X POST $OMNISCOUT_BASE_URL/v0/sessions \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"computer"}')

SESSION_ID=$(echo "$CREATE" | jq -r .session_id)
SESSION_SECRET=$(echo "$CREATE" | jq -r .session_secret)

# Poll until ready
curl -sS $OMNISCOUT_BASE_URL/v0/sessions/$SESSION_ID \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" | jq .status

# Act (API key + session secret)
curl -sS -X POST $OMNISCOUT_BASE_URL/v0/sessions/$SESSION_ID/actions \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" \
  -H "x-session-secret: $SESSION_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"action":"navigate","args":{"url":"https://example.com"}}'

# Destroy (API key only)
curl -sS -X DELETE $OMNISCOUT_BASE_URL/v0/sessions/$SESSION_ID \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY"

種類:"browser"は軽量なブラウザ専用Sprite、"computer"は統合型(1つのセッションIDでブラウザ+デスクトップ)です。セッションは非アクティブで期限切れになります(デフォルト30分、最大2時間) — コマンドのたびに延長されます。

SDK派の方は同じ流れのPython・TypeScript版をSDKでご覧ください。

5. 使用量を確認します

curl -sS $OMNISCOUT_BASE_URL/v0/usage \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" | jq .

課金は従量制のみです(インフラ原価 × 1.30) — 使用量と課金をご覧ください。

次のステップ

  • 認証 — キー、セッションシークレット、ヘッダーについて説明します
  • エンドポイント — すべてのルートのスキーマについて説明します
  • SDK — Python、TypeScript、curlについて説明します
  • エラー — エラー形式と再試行規則について説明します
  • レート制限 — 不正利用防止と支出上限について説明します

On this page