快速开始

使用 APIMUX API Reference 与 CLI 的推荐起点。

文档结构

APIMUX 现在只保留一套官方 API 契约来源：

Canonical API Reference：Dashboard 中 /settings/api-docs 的 OpenAPI + Scalar
Guides：/docs 下的使用说明，只负责 onboarding、认证、错误处理和工作流说明
CLI：apimux，用于本地脚本、自动化和 Agent 场景

这些 guide 不再复制 endpoint 参数表或响应字段表；接口细节以 API Reference 为准。

推荐接入顺序

打开 API Reference：/settings/api-docs
在 /settings/apikeys 创建或复制 API Key
用 Authorization: Bearer <API_KEY> 发起请求
如果你偏好终端或 Agent 工作流，安装并使用 CLI

真实协议

APIMUX 文档化的是真实 wire contract，不是按 source 拆出来的伪独立路由。

标准执行入口是：

POST /v1/capabilities/{capability}

API Reference 同时覆盖以下真实路径：

GET /health
GET /v1/schema
GET /v1/schema/{capability}
POST /v1/capabilities/{capability}

CLI 快速开始

安装最新 CLI：

curl -fsSL https://github.com/reorc/apimux-cli/releases/latest/download/install.sh | sh

初始化本地配置：

apimux config init

查看可用 capability：

apimux schema capabilities
apimux schema show amazon.get_product

运行一个 capability：

apimux amazon get_product --asin B0CM5JV26D --market US

下一步

认证

说明如何在 Dashboard、代码或 CLI 中认证 APIMUX 请求。

目录

推荐接入顺序

CLI 快速开始