开放接口概览
用个人 API 密钥，让你的脚本或 AI 编程会话代你查看项目、接入值守、登记上线和提交模式草稿。
能做什么
开放接口（Open API）面向开发者和 AI 客户端：凭你在 H5 新建的个人 API 密钥，以你本人的身份调用平台。只能操作你有权处理反馈的项目，也就是你创建的项目，或你已接受邀请的开发者项目。每次调用都会记录审计。
命令行工具 yqpj-agent 的 login、attach、publish 等命令就是对这些接口的封装，日常使用直接用命令行即可；需要自己集成时再看本节。
基础信息
| 接口地址前缀 | https://api.yqpj.com/app-api/project/open-api |
| 认证请求头 | X-Api-Key: yqpj_pat_<密钥> |
| 请求体格式 | POST 接口使用 JSON，请求头带 Content-Type: application/json |
| 租户 | 不需要额外传租户，密钥本身决定所属租户 |
返回格式
所有接口统一返回下面的结构：code 为 0 表示成功，结果在 data 里；失败时 code 为错误码，msg 是说明。
{
"code": 0,
"data": { ... },
"msg": ""
}错误码见 错误码与限制。
第一个请求
查看当前密钥对应的用户和权限，用来确认密钥可用：
curl https://api.yqpj.com/app-api/project/open-api/me \
-H "X-Api-Key: yqpj_pat_<你的密钥>"返回的 data 包含 userId、tenantId、name（你的名字）、keyName（密钥名称）和 scopes（这把密钥拥有的权限）。这个接口不要求特定权限，任何有效密钥都能调用。
接口分组
| 分组 | 内容 |
|---|---|
| 认证与密钥 | 新建密钥、权限说明、请求头用法、吊销 |
| 项目 | 查看我的项目、新建项目、修改项目信息、登记项目费用 |
| 值守 | 在会话里接入值守、查看项目反馈单 |
| 上线与更新日志 | 登记一次已完成的部署、查看更新日志页设置 |
| 模式库 | 读取起草用的项目资料、提交 AI 起草的模式条目 |
| 错误码与限制 | 常见错误、原因和处理办法 |
请把密钥当作密码保管，不要写进代码仓库、截图或群聊。