Docs

房源物料

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

房源落地页

POST /site/create:权限范围 tools:sitegen,立即返回。为房源生成带分享链接的落地页:您的房源或任何公开房源。

字段类型说明
objectId字符串必填:房源 ID
siteName字符串您列表中的链接名称
language字符串ENG(默认)、RUS、UKR、DEU、SPA、AZE、ARB、FRA、ZHO、TUR
coverPhotoId字符串首先显示的房源照片
brandColor字符串强调色 #RRGGBB
showPhone是/否在页面上显示您的电话(默认否)
curl -X POST https://developers.grem.capital/api/v1/site/create \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"objectId":"OBJECT_ID","siteName":"Torstraße 12","language":"ZHO"}'

响应:

字段说明
landingId网站 ID
baseUrl网站地址
link创建的链接:名称、语言、代码和地址

缺少 objectId:400;无法访问的房源:403 或 404。

PDF 演示文稿

POST /pdf/create:权限范围 tools:pdf,任务。为房源生成带品牌的 PDF:您的房源或任何公开房源。

字段类型说明
pdfName字符串必填:文件名称,最多 200 字符
objectId字符串必填:房源 ID
language字符串ENG(默认)、RUS、UKR、DEU、SPA、AZE、ARB、FRA、ZHO、TUR
descriptionType字符串presentation(默认)、description 或 social
currency字符串UAH、USD、EUR、AZN、GBP、AED、CNY、TRY、GEL
priceForPdf数字文件中使用的另一个价格
coverPhotoId字符串封面照片
descriptionOverride字符串仅用于此文件的自定义文字,最多 3000 个字符
brandColor字符串强调色 #RRGGBB
curl -X POST https://developers.grem.capital/api/v1/pdf/create \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"pdfName":"Torstraße 12 - 演示文稿","objectId":"OBJECT_ID","language":"ZHO"}'

语言必须是此列表中的大写代码:ru 或 en 会返回 400。

返回 202 和 jobId。完成的任务(GET /pdf/create/jobs/{id}):

字段说明
link文件的直接地址
pageCount页数
sizeBytes大小
coverImageUrl封面

文件也可通过 GET /artifacts/v1/ai/pdf-generator/files/{id}/download 获取。事件:pdf.completed / pdf.failed。

个人传单

POST /flyer/create:权限范围 tools:flyer,立即返回。经纪人传单(A4、方形或快拍),包含您的照片、平台数据和指向您推荐链接的二维码。传单本身免费;只收取 API 调用费用。

字段类型说明
language字符串ENG(默认)及其他代码,与落地页相同;不区分大小写
layouts数组a4(打印)、feed45、square、story、link;默认 ["a4"];至少一个;不区分大小写
formats数组png、jpg、pdf;默认 ["png","pdf"]。PDF 仅为 a4 生成;一到三个;不区分大小写
name、role、city、kicker字符串姓名、职位、城市、副标题
photoRef字符串avatar:您的头像,或 data:image/... 格式的图片
ctaUrl字符串二维码的推荐链接(仅限平台域名)
slogan数组最多 2 行
features数组最多 6 项 { "icon", "title" };icon 为 crm、ai、globe、publisher、marketing、shield、wallet、chart、lock 或 handshake
joinTitle、joinNote字符串加入号召
builtFor数组面向谁,最多 6 行
footer数组最多 2 行
contacts对象联系方式:电话、邮箱等

未知字段会被丢弃。

curl -X POST https://developers.grem.capital/api/v1/flyer/create \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"language":"ZHO","layouts":["a4"],"formats":["pdf"],"name":"Anna Schmidt","role":"房产经纪人","city":"Berlin","photoRef":"avatar"}'

响应:

字段说明
files生成的文件
files[].layout、files[].format版式和文件类型
files[].width、files[].height、files[].bytes尺寸
files[].path下载路径:https://developers.grem.capital/api/v1/artifacts + path
ctaUrl二维码中印制的链接
historyId传单历史记录

从文件或网站生成草稿

POST /draft/extract:权限范围 tools:draft,立即返回。GREM 读取宣传册、价目表或开发商网站,创建带字段和照片的房源草稿。限制:每个账户每天 2 份草稿;超出的请求在次日之前以 403 被拒绝。只收取 API 调用费用,没有工具价格。

请求体:multipart/form-data:

部分说明
dataJSON 字符串:{"type": "property"} 或 {"type": "complex"},可附带 "site": "https://...":必填
文件任意部分名称的文件(PDF、DOC/DOCX、图片)

请发送文件或在 data 中提供 site,否则返回带 files 字段的 400。

curl -X POST https://developers.grem.capital/api/v1/draft/extract \
  -H "Authorization: Bearer gsk_live_xxx" \
  -F 'data={"type":"complex"}' \
  -F "[email protected]" -F "[email protected]"

响应是创建的草稿(未发布)。用 GET /objects/{kind}/{id} 和 PUT /objects/{kind}/{id} 检查并补充(房源)。

相关文章

这篇文章对您有帮助吗?