API
开发者 API: 通过 HTTPS 以编程方式调用 GREM 的工具
快速开始
五分钟完成第一次 GREM API 调用:一个密钥、一次检查、一个同步工具、一个异步任务和一个 webhook
认证
GREM API 密钥:格式、权限范围、机构密钥和经纪人密钥、轮换、有效期、安全
任务与结果
GREM API 异步工具如何运作:state 字段、状态轮询、确认、webhooks 以及下载生成的文件
错误
GREM API 错误格式(RFC 9457):错误码、code 和 errors 字段、哪些重试、哪些修正
限制与计费
GREM API 的请求频率限制、套餐内含的调用额度,以及哪些调用收费、哪些免费
幂等性
用 Idempotency-Key 请求头安全地重试 GREM API 请求:不会重复执行,也不会重复扣费
Webhooks
GREM API 事件:已完成的任务、房源、线索、Swipe Match。订阅、投递格式、HMAC 签名验证、重试
通过 API 使用工具
可通过 API 使用的 GREM 工具:各自的功能、权限范围、同步还是任务、需要哪些输入
估价
通过 GREM API 估价:快速估价、完整估价报告、租金估算和审核他人报告。字段、示例、响应、错误
内容与视频
通过 GREM API 生成内容包、房源文案、照片视频和数字人视频:字段、示例、结果
照片与户型图
通过 GREM API 进行照片优化(光线、移除物品、虚拟家具布置)和户型图清理
房源物料
通过 GREM API 生成房源落地页、PDF 演示文稿、经纪人个人传单,以及从文件生成房源草稿
参考数据
通过 GREM API 获取工具所需的声音、数字人、音乐和结束语,工具可用性以及您的作品历史
房源
通过 GREM API 读取目录和您的房源(出售、出租、住宅小区),创建、编辑、删除、照片以及机构操作
通过 API 管理线索
读取您自己的线索、从外部提交咨询、更改状态、匹配房源以及使用机构线索池
Swipe Match
通过 GREM API 为合作经纪人提供的 Swipe Match 模块线索:收到的推送、已分配线索、交易阶段和事件
文件
为房源和工具上传图片,以及下载生成的结果
字典
把房源类别和属性代码转换为 10 种语言的标签
通过 API 使用对话助手
在您的应用中使用 GREM AI 助手:会话、消息、响应流(SSE)、历史记录、计费
TypeScript SDK
适用于 TypeScript 和 JavaScript 的无依赖 GREM API 客户端:全部操作、任务、错误、webhooks、对话
版本与 API 变更
GREM API 如何变化、什么算兼容变更、如何编写不会出错的客户端,以及变更日志
沙盒
在不执行真实工作、不花钱的情况下测试与 GREM API 的集成:测试密钥、模拟工具和任务、选择结果、限制