用途:提供一个最小可用的 Hex API 示例,适合在开始新的 Hex 集成、测试配置或学习基本 API 模式时使用。前置条件为已完成 hex-install-auth 配置,并至少有一个已发布的 Hex 项目。
主要能力:列出工作区项目并显示名称、项目 ID 与状态;触发已发布项目的运行,可传入输入参数;轮询运行状态直至完成;通过 curl 快速验证。
使用方式:先调用 GET https://app.hex.tech/api/v1/projects 获取项目列表,请求头携带 Authorization: Bearer $HEX_API_TOKEN。再向 https://app.hex.tech/api/v1/project/PROJECT_ID/run 发送 POST 触发运行,请求体可包含 inputParams 和 updateCacheResult。随后轮询 https://app.hex.tech/api/v1/project/PROJECT_ID/run/RUN_ID,直到状态为 COMPLETED;若为 ERRORED 或 KILLED 则视为失败。示例中轮询间隔为 5 秒,超时可自定义。
常见错误:401 表示令牌无效,需重新生成;403 表示令牌只读,需创建带运行项目权限的令牌;404 表示项目未找到,需确认项目 ID 且项目已发布;Run ERRORED 表示项目代码失败,需查看 Hex 项目日志。
限制:资料未提供完整错误码清单、速率限制、并发或配额信息,也未给出定价与平台支持情况;示例中的参数、项目 ID 与结果均为演示用,需替换为真实值。