OmniScout Docs

認証

OmniScout Cloud APIキーの作成と利用。

すべてのCloud APIリクエストにはAuthorizationヘッダーにBearerトークンが必要です。

検索・回答エンドポイントはこのAPIキーのみで利用できます。ブラウザ・コンピューターセッションコマンドでは2つ目の認証情報も必要です:セッション作成時に返されるsession_secretです(エンドポイント → ブラウザセッションを参照)。

APIキー

APIキーはダッシュボードで作成します。各キーについて:

  • os_live_で始まる
  • Clerkアカウントに紐づく
  • 独立した利用量トラッキングを持つ
  • いつでも取り消し可能
Authorization: Bearer os_live_abc123...

キーの作成

  1. api.omniscout.xyzでサインインします。
  2. Dashboard → API Keysに移動します。
  3. Create keyをクリックして値をコピーします — 初回のみ表示されます。

キーはソースコードではなく環境変数に保存してください:

export OMNISCOUT_API_KEY=os_live_abc123...

リクエスト例

curl -X POST https://api.omniscout.xyz/v0/search \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "python async patterns"}'

セッションシークレット

セッションルートでは2つの認証情報を使います:

認証情報ヘッダー使用場面
APIキーAuthorization: Bearer os_live_...作成、コマンド、ファイルのアップロード/ダウンロード、削除
セッションシークレットx-session-secret: <secret>コマンド、ファイルのアップロード/ダウンロードのみ

セッションシークレットは作成レスポンスで一度だけ返されます(session_secret)。session_idと一緒に保存してください — 後から取得できません。

# 作成(APIキーのみ)
curl -X POST https://api.omniscout.xyz/v0/computer/sessions \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY"

# コマンド(APIキー+セッションシークレット)
curl -X POST "https://api.omniscout.xyz/v0/computer/sessions/$SESSION_ID" \
  -H "Authorization: Bearer $OMNISCOUT_API_KEY" \
  -H "x-session-secret: $SESSION_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"action":"computer.type","args":{"text":"hello"},"session":"default"}'

削除にはAPIキーのみが必要です(セッションシークレット不要)。

エラーレスポンス

ステータス意味
401APIキーがない・無効
401セッションコマンド・ファイルルートのx-session-secretが無効
429日次レート制限を超過

すべてのエラーレスポンスにはデバッグ用のrequest_idが含まれます:

{
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "error": {
    "type": "unauthorized",
    "message": "Invalid API key"
  }
}

On this page