Back to Details

omni-compression

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- generated by src/lib/agentSkills/generator.ts; manual edits will be overwritten -->
<!-- 由 src/lib/agentSkills/generator.ts 生成；手动编辑将被覆盖 -->

Overview

概览

Configure RTK (command output), Caveman (prose), and stacked compression modes. Manage language packs, custom rules, and test prompt compression reducing tokens by 60–90%.
配置 RTK（命令输出）、Caveman（自然语言文本）和堆叠压缩模式。管理语言包、自定义规则，并测试可将 Token 减少 60–90% 的提示词压缩。

Authentication

身份验证

All requests require a valid Bearer token or session cookie. Obtain a token via 
POST /api/auth/login
or configure 
REQUIRE_API_KEY=false
for local development.
所有请求都需要有效的 Bearer token 或会话 Cookie。可通过 
POST /api/auth/login
获取 token，或在本地开发环境中配置 
REQUIRE_API_KEY=false
。

Endpoints

端点

POST /api/compression/preview

POST /api/compression/preview

Preview compression for a message payload
bash
curl -X POST http://localhost:20128/api/compression/preview \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
预览消息载荷的压缩效果
bash
curl -X POST http://localhost:20128/api/compression/preview \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET /api/compression/language-packs

GET /api/compression/language-packs

List Caveman compression language packs
bash
curl http://localhost:20128/api/compression/language-packs \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
列出 Caveman 压缩语言包
bash
curl http://localhost:20128/api/compression/language-packs \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

GET /api/compression/rules

GET /api/compression/rules

List Caveman compression rule metadata
bash
curl http://localhost:20128/api/compression/rules \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
列出 Caveman 压缩规则元数据
bash
curl http://localhost:20128/api/compression/rules \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

POST /api/compression/compare

POST /api/compression/compare

POST compression › compare
bash
curl -X POST http://localhost:20128/api/compression/compare \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
POST compression › compare
bash
curl -X POST http://localhost:20128/api/compression/compare \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

POST /api/compression/compare/verify

POST /api/compression/compare/verify

POST compression › compare › verify
bash
curl -X POST http://localhost:20128/api/compression/compare/verify \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
POST compression › compare › verify
bash
curl -X POST http://localhost:20128/api/compression/compare/verify \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET /api/compression/engines

GET /api/compression/engines

GET compression › engines
bash
curl http://localhost:20128/api/compression/engines \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
GET compression › engines
bash
curl http://localhost:20128/api/compression/engines \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

POST /api/compression/retrieve

POST /api/compression/retrieve

POST compression › retrieve
bash
curl -X POST http://localhost:20128/api/compression/retrieve \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
POST compression › retrieve
bash
curl -X POST http://localhost:20128/api/compression/retrieve \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Payloads

载荷

See the full OpenAPI specification at 
GET /api/openapi/spec
or 
docs/openapi.yaml
for detailed request/response schemas.
<!-- skill:custom-start --> <!-- Migrated from skills/omniroute-compression/SKILL.md (preserved curated content) -->
有关详细的请求/响应 schema，请参阅 
GET /api/openapi/spec
或 
docs/openapi.yaml
中的完整 OpenAPI specification。
<!-- skill:custom-start --> <!-- 从 skills/omniroute-compression/SKILL.md 迁移（保留精选内容） -->

OmniRoute — Compression

OmniRoute — 压缩

Requires 
OMNIROUTE_URL
and 
OMNIROUTE_KEY
. See entry-point SKILL for setup.
需要 
OMNIROUTE_URL
和 
OMNIROUTE_KEY
。有关设置，请参阅入口 SKILL。

Overview

概览

OmniRoute compresses token payloads before forwarding to providers. No code changes required — set it once, it applies to all requests transparently.
EngineBest forTypical savings
RTKTerminal / build / test / git output60–90%
CavemanHuman prose, chat history46% input
Stacked (
rtk → caveman
)		Mixed coding sessions78–95%
MCP accessibility filterBrowser/accessibility tool results60–80%
OmniRoute 会在将 Token 载荷转发给 providers 前对其进行压缩。无需更改代码，只需设置一次，即可透明地应用于所有请求。
引擎最适合典型节省率
RTK终端 / 构建 / 测试 / git 输出60–90%
Caveman人类文本、聊天记录输入减少 46%
Stacked (
rtk → caveman
)		混合编码会话78–95%
MCP 可访问性过滤器浏览器/可访问性工具结果60–80%

Get current settings

获取当前设置

bash
curl $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY"
bash
curl $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY"

Enable RTK (best for coding agents)

启用 RTK（最适合编码 Agent）

bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "rtk", "enabled": true }'
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "rtk", "enabled": true }'

Enable stacked mode (maximum savings)

启用堆叠模式（节省率最高）

bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "stacked",
    "enabled": true,
    "stackedPipeline": ["rtk", "caveman"]
  }'
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "stacked",
    "enabled": true,
    "stackedPipeline": ["rtk", "caveman"]
  }'

Enable Caveman (prose / chat)

启用 Caveman（文本/聊天）

bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "standard", "enabled": true }'
Caveman intensities: 
lite
(safe), 
standard
(balanced), 
aggressive
(long sessions), 
ultra
(context recovery).
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "standard", "enabled": true }'
Caveman 强度：
lite
（安全）、
standard
（均衡）、
aggressive
（长会话）、
ultra
（上下文恢复）。

Preview compression before enabling

启用前预览压缩效果

bash
curl -X POST $OMNIROUTE_URL/api/compression/preview \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "rtk",
    "text": "$ npm test\n> jest\n\nPASS src/a.test.ts (2.1s)\nPASS src/b.test.ts (1.8s)\n..."
  }'
Response includes 
compressed
, 
original_length
, 
compressed_length
, 
savings_pct
.
bash
curl -X POST $OMNIROUTE_URL/api/compression/preview \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "rtk",
    "text": "$ npm test\n> jest\n\nPASS src/a.test.ts (2.1s)\nPASS src/b.test.ts (1.8s)\n..."
  }'
响应包含 
compressed
、
original_length
、
compressed_length
和 
savings_pct
。

MCP accessibility-tree filter (browser agent use)

MCP 可访问性树过滤器（供 browser Agent 使用）

When OmniRoute is used with browser/Playwright MCP tools, it automatically compresses verbose accessibility-tree tool results. Enabled by default; configure thresholds:
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mcpAccessibility": {
      "enabled": true,
      "collapseThreshold": 30,
      "maxTextChars": 50000
    }
  }'
collapseThreshold
: collapse sibling lines when ≥ N repeats (default 30).
maxTextChars
: hard truncate after N chars with navigation hint (default 50000).
当 OmniRoute 与 browser/Playwright MCP 工具配合使用时，它会自动压缩冗长的可访问性树工具结果。该功能默认启用；可配置阈值：
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mcpAccessibility": {
      "enabled": true,
      "collapseThreshold": 30,
      "maxTextChars": 50000
    }
  }'
collapseThreshold
：当同级行重复次数 ≥ N 时将其折叠（默认 30）。
maxTextChars
：超过 N 个字符后强制截断，并附加导航提示（默认 50000）。

Language packs (Caveman)

语言包（Caveman）

Caveman supports language-aware rules for pt-BR, es, de, fr, ja:
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "standard",
    "cavemanConfig": {
      "language": "pt-BR",
      "autoDetectLanguage": true
    }
  }'
Caveman 支持适用于 pt-BR、es、de、fr、ja 的语言感知规则：
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "standard",
    "cavemanConfig": {
      "language": "pt-BR",
      "autoDetectLanguage": true
    }
  }'

Via MCP

通过 MCP

omniroute_compression_status     → current settings + savings analytics
omniroute_compression_configure  → update mode/threshold/language
omniroute_set_compression_engine → switch engine at runtime
omniroute_compression_status     → current settings + savings analytics
omniroute_compression_configure  → update mode/threshold/language
omniroute_set_compression_engine → switch engine at runtime

Disable compression

禁用压缩

bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -d '{ "enabled": false }'
bash
curl -X PUT $OMNIROUTE_URL/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_KEY" \
  -d '{ "enabled": false }'

Errors

错误

  • 400 invalid mode
    → use 
    off
    , 
    lite
    , 
    standard
    , 
    aggressive
    , 
    ultra
    , 
    rtk
    , or 
    stacked
  • 400 invalid stackedPipeline
    → array must contain valid engine ids (
    rtk
    , 
    caveman
    )
<!-- skill:custom-end -->
  • 400 invalid mode
    → 使用 
    off
    、
    lite
    、
    standard
    、
    aggressive
    、
    ultra
    、
    rtk
    或 
    stacked
  • 400 invalid stackedPipeline
    → 数组必须包含有效的引擎 ID（
    rtk
    、
    caveman
    ）
<!-- skill:custom-end -->