Docs

Швидкий старт

Останнє оновлення: 2026-10-033 хв читання

API GREM дає програмний доступ до того самого, що є в кабінеті: інструментів (оцінка, тексти, відео, фото, 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": <число>, "rangeLow": <число>, "rangeHigh": <число>, "confidence": "<рівень>", "currency": "EUR" },
  "requestId": "req_..."
}

Idempotency-Key робить повтор безпечним: повторний запит з тим самим ключем поверне перший результат і не спише гроші вдруге.

Запустіть відкладене завдання

Довгі інструменти відповідають 202 і повертають завдання. Якщо хочете отримати результат вебхуком, спершу підпишіться (крок 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"

Як працюють завдання і як забрати готові файли: Завдання і результати.

Отримуйте результат вебхуком

Замість опитування підпишіться на подію - GREM надішле POST на ваш URL, коли завдання завершиться. Підписуйтеся до запуску завдання: завдання, запущене до підписки, своєї події не надішле.

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_... - він показується один раз. Як перевіряти підпис: Вебхуки.

Перевіряйте без витрат: ключ з префіксом gsk_test (при створенні оберіть тип ключа Тестовий) працює в пісочниці: інструменти відповідають зразками результатів, нічого не створюється й не списується.

Що далі

Ця стаття була корисною?