Docs

通过 API 使用工具

最后更新: 2026-09-07阅读约 5 分钟

您在后台使用的那些工具,同样可以通过程序调用。每次调用都与在界面中操作一样从钱包扣费:先用订阅额度,再用套餐包,最后按量付费。读取(GET)永远不计费。

基础地址:https://developers.grem.capital/api/v1

工具清单

调用所需权限范围工作方式
POST /valuation/express任意密钥同步
POST /valuation/reporttools:valuation异步
POST /valuation/renttools:rent同步
POST /valuation/reviewtools:review异步,需带文件
POST /content/generatetools:contentgen异步
POST /text/generatetools:text异步
POST /avatar/videotools:avatar异步
POST /video/createtools:video异步,需带文件
POST /photo/enhancetools:photo异步,需带文件
POST /floorplan/createtools:floorplan异步,需带文件
POST /draft/extracttools:draft同步,需带文件
POST /site/createtools:sitegen同步,需要已有房源
POST /pdf/createtools:pdf异步,需要已有房源

若密钥缺少相应权限范围,调用会返回 403。权限范围在后台创建密钥时授予:AI 工具 → API → 密钥。参见鉴权

同步调用

同步工具会返回 200,响应体中直接给出结果:

curl -X POST https://developers.grem.capital/api/v1/valuation/rent \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"propertyCategory":"apartment","totalArea":50,"city":"Kyiv"}'

异步调用

耗时较长的工具(估价报告、文案、照片、视频、数字人、户型图、PDF)会返回 202 以及任务句柄:

{ "jobId": "…", "status": "pending", "requestId": "req_…" }

通过 GET /<工具路径>/jobs/{jobId} 查询状态:

curl -H "Authorization: Bearer gsk_live_xxx" \
  https://developers.grem.capital/api/v1/content/generate/jobs/JOB_ID

响应中带有 status 字段。终态为 completed(或 donesuccess)和 failed。任务运行期间,可每隔几秒重复查询一次。

轮询是免费的:GET 不计入 API 调用次数,也不扣费。即便如此,订阅事件仍优于密集轮询 — 参见 Webhook

每个任务都归属创建它的密钥。他人的 jobId 一律返回 404,即使该任务确实存在。

需要上传文件的工具

标注"需带文件"的调用接受 multipart/form-data:参数以 JSON 形式放在名为 data 的文本字段中,文件本身作为独立的部分。

curl -X POST https://developers.grem.capital/api/v1/photo/enhance \
  -H "Authorization: Bearer gsk_live_xxx" \
  -F 'data={"mode":"enhance"}' \
  -F "image=@room.jpg"

若向这类接口发送普通 JSON,会返回 400,并提示应使用 multipart/form-data

需要已有房源的工具

网站生成器和 PDF 生成器基于已有房源来制作演示,因此请求体中必须带 objectId(若为精选则用 collectionId)。房源必须属于您 — 他人的 id 会返回权限错误。

curl -X POST https://developers.grem.capital/api/v1/pdf/create \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"objectId":"64f…","language":"en"}'

生成的文件

结果(PDF、视频、图片、页面)以 GREM 域名下的链接形式返回。用同一个密钥通过 GET /artifacts/… 下载 — 参见文件与结果

重试而不重复

创建任务可以安全重试:发送 Idempotency-Key 请求头,使用同一个键的重试会返回最初的结果,而不会重复计费。详见幂等性

错误的含义

  • 402 — 钱包余额不足,或套餐额度已用完。
  • 403 — 该密钥没有此工具的权限范围。
  • 429 — 触发了频率限制;请按 Retry-After 响应头中的等待时间后重试。

完整清单见错误

相关文章

这篇文章对您有帮助吗?