Інструменти через API

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

Ті самі інструменти, що й у кабінеті, доступні програмно. Кожен виклик списується з вашого гаманця так само, як робота через інтерфейс: підписка, потім пакет, потім оплата за фактом. Читання (GET) не списується ніколи.

Базовий URL: https://developers.grem.capital/api/v1.

Перелік інструментів

Виклик	Scope ключа	Як працює
`POST /valuation/express`	будь-який ключ	синхронно
`POST /valuation/report`	`tools:valuation`	відкладено
`POST /valuation/rent`	`tools:rent`	синхронно
`POST /valuation/review`	`tools:review`	відкладено, з файлом
`POST /content/generate`	`tools:contentgen`	відкладено
`POST /text/generate`	`tools:text`	відкладено
`POST /avatar/video`	`tools:avatar`	відкладено
`POST /video/create`	`tools:video`	відкладено, з файлом
`POST /photo/enhance`	`tools:photo`	відкладено, з файлом
`POST /floorplan/create`	`tools:floorplan`	відкладено, з файлом
`POST /draft/extract`	`tools:draft`	синхронно, з файлом
`POST /site/create`	`tools:sitegen`	синхронно, потрібен обʼєкт
`POST /pdf/create`	`tools:pdf`	відкладено, потрібен обʼєкт

Якщо у ключа немає потрібного scope, виклик поверне 403. Scope видаються під час створення ключа в кабінеті: 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 (або done, success) і failed. Поки завдання виконується, повторюйте запит раз на кілька секунд.

Опитування безкоштовне: GET не рахується викликом API і не списується з гаманця. Але замість щільного опитування краще підписатися на подію - див. Вебхуки.

Кожне завдання належить тому ключу, який його створив. Чужий jobId завжди повертає 404, навіть якщо таке завдання існує.

Інструменти з файлом

Виклики, позначені «з файлом», приймають multipart/form-data: параметри - у текстовому полі data у вигляді JSON, сам файл - окремою частиною.

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 для добірки). Обʼєкт має належати вам - чужий ідентифікатор дасть помилку доступу.

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":"uk"}'

402 - на гаманці недостатньо коштів або вичерпано квоту плану.
403 - у ключа немає scope для цього інструмента.
429 - перевищено ліміт частоти, повторіть після паузи з заголовка Retry-After.

Повний перелік - у статті Помилки.

Пов'язані статті

Швидкий старт - перший виклик за пʼять хвилин.
Вебхуки - отримувати готовий результат замість опитування.
Файли та готові результати - завантаження зображень і скачування артефактів.

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