Docs

快速开始

最后更新: 2026-10-03阅读约 4 分钟

GREM API 让您以编程方式使用后台提供的功能：工具（估价、文案、视频、照片、PDF、网站）、您的房源、线索和事件。所有请求都发往同一个地址：

https://developers.grem.capital/api/v1

完整的机器可读描述见 /openapi.json，交互式版本见 /docs。

创建密钥

在后台打开 API → 密钥，点击 创建密钥。密钥只显示一次，请保存到密钥管理器中。新密钥默认拥有全部权限范围，创建时可以缩小范围。详情：认证。

检查密钥

curl https://developers.grem.capital/api/v1/ping \
  -H "Authorization: Bearer gsk_live_xxx"

返回 {"ok": true, ...} 表示密钥可用。GET /ping 免费，不需要权限范围。GET /me 显示该密钥具体能做什么。

调用同步工具

快速估价会立即返回：

curl -X POST https://developers.grem.capital/api/v1/valuation/express \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6b1f0c2e-6c1e-4a8e-9f5d-3c2a1b0e9d87" \
  -d '{"propertyCategory":"apartment","addressText":"Torstraße 12, Berlin","totalArea":64,"rooms":2,"currency":"EUR"}'

{
  "estimate": { "pricePoint": <number>, "rangeLow": <number>, "rangeHigh": <number>, "confidence": "<level>", "currency": "EUR" },
  "requestId": "req_..."
}

Idempotency-Key 让重试变得安全：用同一个键重复请求会返回第一次的结果，不会再次扣费。

启动异步任务

耗时较长的工具返回 202 和一个任务。如需通过 webhook 获取结果，请先订阅（第 5 步）：在订阅之前启动的任务不会发送其事件。

curl -X POST https://developers.grem.capital/api/v1/text/generate \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"city":"Berlin","totalArea":64,"rooms":2,"propertyCategory":"apartment","language":"en"}'

{ "jobId": "...", "status": "...", "state": "pending", "requestId": "req_..." }

轮询状态（免费），直到 state 变为 completed、partial 或 failed：

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

任务如何运作以及如何下载文件：任务与结果。

通过 webhook 接收结果

无需轮询，订阅事件即可：任务完成时 GREM 会向您的 URL 发送 POST。请在启动任务之前订阅：在订阅之前启动的任务不会发送其事件。

curl -X POST https://developers.grem.capital/api/v1/webhooks \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/grem-hook","events":["text.completed","text.failed"]}'

响应中包含签名密钥 whsec_...，只显示一次。如何验证签名：Webhooks。

无需花费即可测试：前缀为 gsk_test 的密钥（创建时选择密钥类型 测试）在沙盒中运行：工具返回示例结果，不创建任何内容，也不收费。

下一步

这篇文章对您有帮助吗？