Те же инструменты, что в кабинете, доступны программно. Инструмент стоит столько же, сколько в кабинете, плюс один вызов API (Лимиты и оплата). Базовый адрес: https://developers.grem.capital/api/v1.
Список
| Инструмент | Запрос | Область | Как работает |
|---|---|---|---|
| Экспресс-оценка | POST /valuation/express | tools:valuation | сразу |
| Полный отчет об оценке | 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 /video/create | tools:video | задача, с файлами |
| Видео с аватаром | POST /avatar/video | tools:avatar | задача |
| Улучшение фото | POST /photo/enhance | tools:photo | задача, с файлом |
| Очистка планировки | POST /floorplan/create | tools:floorplan | сразу (ответ 202 уже с результатом), с файлом |
| Сайт объекта | POST /site/create | tools:sitegen | сразу |
| PDF-презентация | POST /pdf/create | tools:pdf | задача |
| Персональный флаер | POST /flyer/create | tools:flyer | сразу |
| Черновик из документов | POST /draft/extract | tools:draft | сразу, с файлами |
Поля каждого инструмента, примеры и ошибки:
- Оценка - экспресс, полный отчет, аренда, проверка отчета.
- Контент и видео - пакет контента, тексты, видео, аватар.
- Фото и планировки - улучшение фото, планировка.
- Материалы объявления - сайт, PDF, флаер, черновик.
Идентификаторы, которые инструменты принимают на входе (голос, аватар, музыка, финальная фраза), и текущая доступность инструментов: Справочные данные.
Как отправлять данные
- JSON - большинство инструментов:
Content-Type: application/json. - multipart/form-data - инструменты с файлами. Формат полей у них разный, и это важно:
- улучшение фото и черновик - параметры одной JSON-строкой в поле
data, файлы отдельными частями; - видео - каждый параметр отдельным полем формы (
prompt,length,musicTrackId...), фото частямиphotos; - проверка отчета и планировка - файл в части
file, параметры отдельными полями.
- улучшение фото и черновик - параметры одной JSON-строкой в поле
Отправить JSON инструменту, который ждет файл, - 400.
Ответы
- Синхронный инструмент отвечает
200с результатом. - Отложенный отвечает
202с задачей; результат - опросом или вебхуком (Задачи и результаты). - Готовые файлы скачиваются через
GET /artifacts/{path}.
Каждый запрос, запускающий инструмент, стоит отправлять с Idempotency-Key (Идемпотентность).
Чего через API нет
3D-тур и отчет о рынке района пока доступны только в кабинете.