用途
Gamma Debug Bundle 是一个用于排查 Gamma API 集成问题的调试工具包。Gamma 提供 REST API,地址为 https://public-api.gamma.app/v1.0/,并通过 X-API-KEY 请求头进行认证。该工具包用于在集成出现异常时进行详细诊断、请求追踪和系统性调试。
主要能力
工具包包含以下部分:
-
快速连通性测试(curl):检查 GAMMA_API_KEY 是否已设置;通过 /themes 端点测试认证状态并区分 401(无效 API Key)与 403(账户不在 Pro+ 套餐);测量延迟(3 次采样);列出工作区主题以验证 API 访问。
-
TypeScript 诊断脚本(scripts/gamma-diagnose.ts):依次测试 API Key 是否设置、认证是否通过、Folders API 是否可用、Generation API 是否可启动,并输出带延迟的逐项结果报告,统计失败数量。运行时需执行
npx tsx scripts/gamma-diagnose.ts。注意 Generation 测试会消耗积分,自动化测试中应跳过。 -
带请求日志的调试客户端(src/gamma/debug-client.ts):封装 generate、poll、listThemes、listFolders 方法,打印请求方法、路径、状态、耗时及错误响应内容,便于追踪每一次请求。
-
支持工单模板:包含环境信息、问题描述、API 请求详情、复现步骤、诊断输出、账户套餐与积分余额等字段。
输出
创建一个经过脱敏的证据索引,包含不透明的关联 ID、工件列表、访问所有者、保留日期、复现结果和下一步操作。敏感原始文件保留在经批准的事件存储中。
使用方式
前提条件:已有可用的 Gamma 集成;Node.js 18+ 或 Python 3.10+;可用 curl 和 jq。
按步骤操作:先运行 curl 快速连通性测试;再运行 TypeScript 诊断脚本;如需追踪请求细节,可使用调试客户端封装;排查完成后可填写支持工单模板。例如对于一次模拟的发布失败,仅保留运行时/配置引用和聚合错误,检查工具包中的私密内容或令牌,将访问权限限制给事件负责人,并在保留日期到期后销毁。
适用场景
适用于 Gamma API 集成出现认证失败、请求异常、生成失败、导出链接为空、轮询超时等问题时的排查,也适用于向 Gamma 支持提交结构化诊断信息。
限制与注意事项
诊断脚本中的 Generation API 测试会消耗积分,不应在自动化测试中运行。常见问题速查表列出了 401、403、429、生成状态失败、导出链接为空、轮询超时等可能的症状、原因与修复方向。资料未提供具体的收费、价格信息,也未提供更多未列出的功能说明。下一阶段建议参考 gamma-rate-limits 进行速率限制管理。