云 API 概览
OmniScout 云 API:搜索、有据问答以及浏览器/电脑会话。
OmniScout Cloud 是托管 API,提供语义搜索、有据问答以及远程浏览器/电脑会话。它与本地 CLI 使用相同的检索与重排序流水线,后端是自有的 Qdrant 索引而非 DuckDuckGo。
你将获得
| 能力 | 端点 | 说明 |
|---|---|---|
| 搜索 | POST /v0/search | 在自有索引上的混合向量 + BM25 检索,使用 omniscout 重排序 |
| 问答 | POST /v0/answer | 搜索 → 提取 → AI 综合,附来源与置信度 |
| 浏览器会话 | POST /v0/browser/sessions | 轻量纯浏览器 Sprite(capabilities: ["browser"]) |
| 电脑会话 | POST /v0/computer/sessions | 统一 Sprite,含浏览器 + 桌面(capabilities: ["browser", "computer"]) |
| 会话文件 | POST/GET /v0/sessions/{id}/files | 向 Sprite 上传文件或从中下载 |
会话调用方的变化
POST /v0/search 和 POST /v0/answer 保持不变。
会话端点路径与之前相同,差异如下:
- 从创建响应中保存
session_secret——每个命令和文件请求都需要通过x-session-secret携带。 - 电脑会话已统一——一个
session_id同时支持浏览器命令(POST /v0/browser/sessions/{id})和电脑命令(POST /v0/computer/sessions/{id})。已有电脑会话时不再需要单独的浏览器会话。 - 操作名称——浏览器操作使用裸名称(
navigate、screenshot);电脑操作使用computer.前缀(computer.type、computer.screenshot)。 - 文件路由是新增的——使用
/v0/sessions/{id}/files向 Sprite 上传文件或下载截图/PDF。 - 过期基于空闲时间——每次命令都会续期(默认空闲 30 分钟,最长 2 小时)。不要假定从创建时间起的固定 TTL。
# 1. 创建统一电脑会话(仅需 API 密钥)
curl -X POST https://api.omniscout.xyz/v0/computer/sessions \
-H "Authorization: Bearer $OMNISCOUT_API_KEY"
# 响应包含 session_id、session_secret、capabilities: ["browser","computer"]
# 2. 在同一会话上执行浏览器命令(需要两个请求头)
curl -X POST "https://api.omniscout.xyz/v0/browser/sessions/$SESSION_ID" \
-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"}}'
# 3. 在同一会话上执行电脑命令
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"}}'快速开始
- 在 api.omniscout.xyz 注册(或你的部署 URL)。
- 在控制台创建 API 密钥——密钥以
os_live_开头。 - 发送第一个请求:
curl -X POST https://api.omniscout.xyz/v0/search \
-H "Authorization: Bearer os_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "rust async runtimes", "limit": 10}'命令行 vs 云端
| 命令行 | 云 API | |
|---|---|---|
| 搜索来源 | DuckDuckGo + 本地重排序 | 自有 Qdrant 索引 + omniscout 重排序 |
| 问答 | 本地 Probe Zero Mini | Vercel AI Gateway(可配置模型) |
| 浏览器 | 你的本地 Chrome / Playwright | 带 omniscout daemon 的 Fly Sprite |
| 认证 | 无(本地运行) | Bearer API 密钥(os_live_...) |
| 计费 | 免费、开源 | 免费额度 + 付费计划 |
本地 CLI 保持不变。云端是增补——按部署需求任选其一。
架构
Client → Vercel gateway (/v0/*) → Fly search worker → Qdrant Cloud
→ Vercel AI Gateway (answers)
→ Fly Sprites (browser/computer)- Vercel 托管控制台、API 网关、Clerk 认证和 Convex(密钥、用量、会话)。
- Fly.io 运行搜索 worker、索引器和 Sprite。
- Qdrant Cloud 存储自有搜索索引(Common Crawl + StormCrawler,增量摄取)。
下一步
- 认证与 API 密钥——如何创建和使用密钥
- 端点——每条路由的请求/响应结构
- 速率限制——每日配额与层级
- OpenAPI 参考——交互式 API 浏览器