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 (при создании выберите тип ключа Тестовый) работает в песочнице: инструменты отвечают образцами результатов, ничего не создаётся и не списывается.

Что дальше

Эта статья была полезной?