API Gerwin AI

1. Что доступно сейчас

Коротко: публичный API Gerwin AI сейчас работает только с прежней версией Сервиса и ее навыками. Новые модели и приложения из актуального интерфейса Gerwin AI через этот API пока недоступны.

Это legacy API — поддерживаемый интерфейс предыдущего поколения. Он подходит для интеграций, которым нужны уже существующие текстовые навыки. Доступ находится в ограниченном режиме, подключается вручную и предоставляется по заявке.

Наличие функции, модели или приложения в новом веб-интерфейсе не означает, что она доступна через API. Актуальный список навыков, адреса методов, форматы запросов, лимиты и стоимость указываются в технической документации, выданной при подключении.

2. Чем навык отличается от модели

Навык — это готовый сценарий обработки с заранее определенной задачей, входными параметрами и форматом результата. Например, навык может принять исходный текст и выполнить предусмотренное для него преобразование.

Модель — это конкретная нейросеть, которую пользователь выбирает в новой версии Gerwin AI. Legacy API не предоставляет прямой выбор новых моделей и не открывает доступ к каталогу современных приложений.

Простая схема работы выглядит так:

1. интеграция выбирает доступный навык;
2. отправляет предусмотренные этим навыком данные;
3. получает идентификатор задания;
4. проверяет статус и забирает готовый результат.

Если вам нужен API именно к новой модели или приложению Gerwin AI, сначала уточните доступность такого подключения у поддержки.

3. Как получить доступ

Перед подключением необходимо пополнить баланс аккаунта минимум на 1 000 000 кредитов.

Пополнение баланса не включает API автоматически и не гарантирует одобрение заявки. После пополнения отправьте запрос в поддержку: подключение выполняется вручную после проверки сценария использования.

Направьте запрос на team@gerwin.ai и опишите:

• email аккаунта Gerwin AI, баланс которого был пополнен;
• организацию или проект;
• предполагаемый сценарий и тип контента;
• ожидаемый объем и частоту запросов;
• необходимые навыки и форматы результата;
• требования к хранению данных и поддержке.

Мы можем запросить дополнительную информацию для оценки безопасности, нагрузки и договорных условий. После одобрения вы получите параметры подключения и актуальную техническую документацию.

Для новичка весь процесс состоит из трех шагов:

1. пополнить баланс аккаунта минимум на 1 000 000 кредитов;
2. написать в поддержку и описать интеграцию;
3. дождаться ручной проверки и получить доступ.

4. Авторизация

Используйте только способ авторизации, указанный в документации, выданной при подключении. Если токен получается через отдельный метод входа, передавайте учетные данные только на официальный HTTPS-адрес авторизации Gerwin AI, а в рабочих запросах используйте полученный токен.

Никогда не встраивайте пароль или токен в клиентское приложение, браузерный код, мобильный пакет или публичный репозиторий.

Рекомендуется:

• хранить секрет только на защищенном сервере или в менеджере секретов;
• использовать отдельный ключ для каждого окружения;
• выдавать минимально необходимые права;
• регулярно менять ключи и немедленно отзывать скомпрометированные;
• скрывать секреты из журналов, аналитики и сообщений об ошибках;
• ограничивать исходящие адреса и бюджет, если такая возможность доступна.

Пользователь отвечает за действия, выполненные с его действующим токеном или иными учетными данными интеграции, пока не уведомит Gerwin AI о компрометации.

5. Запросы, задания и результаты

Операции legacy API могут выполняться асинхронно. Интеграция должна корректно обрабатывать:

• принятие задания и его идентификатор;
• промежуточный статус;
• завершение, отказ модерации и ошибку поставщика;
• повторную доставку webhook-события;
• временную недоступность и безопасный повтор запроса.

Не полагайтесь на неописанные поля и порядок объектов. Используйте только навыки и параметры из выданной документации.

6. Лимиты и стабильность

К API могут применяться:

• ограничения частоты и параллельности;
• лимиты размера и формата файлов;
• дневной или договорный бюджет;
• тайм-ауты отдельных навыков;
• очереди в периоды высокой нагрузки.

Если при подключении не согласован другой лимит, ориентируйтесь на базовое ограничение: не чаще одного запроса раз в четыре секунды. При ответах об ограничении частоты используйте повтор с экспоненциальной задержкой и случайным отклонением. Агрессивные повторы, обход лимитов и распределение нагрузки между учетными записями запрещены.

Экспериментальные методы могут меняться. Для критичных интеграций согласуйте версию, срок уведомления об изменениях и уровень поддержки отдельным договором.

7. Оплата

Для подключения требуется предварительно пополнить баланс минимум на 1 000 000 кредитов. Во время работы на аккаунте должен сохраняться положительный баланс.

Стоимость операции зависит от выбранного навыка, его параметров, фактического объема и условий подключения. Legacy API не тарифицируется как прямой доступ к новым моделям, потому что такой доступ сейчас не предоставляется.

Если технический сбой привел к ошибочному списанию, направьте идентификатор операции в поддержку. Условия возврата денежных средств определяются Политикой возврата, а восстановление внутренних единиц может происходить автоматически или после проверки.

8. Модерация и допустимое использование

API не отменяет правила безопасности. Запросы, входные файлы и результаты могут проверяться Gerwin AI и поставщиками используемых технологий.

Интегратор обязан:

• соблюдать Правила модерации контента;
• не предоставлять доступ третьим лицам без предусмотренной договором модели авторизации;
• реализовать собственные меры контроля, подходящие его продукту и аудитории;
• не скрывать синтетическое происхождение контента там, где маркировка обязательна;
• оперативно пресекать злоупотребления конечных пользователей.

9. Персональные данные и конфиденциальность

Не отправляйте персональные данные, секреты, биометрические сведения и охраняемую законом информацию, если это не требуется сценарием и не оформлены необходимые основания, поручения и меры защиты.

Для корпоративной обработки стороны могут заключить отдельное соглашение. Общие положения изложены в Политике обработки персональных данных.

10. Приостановление доступа

Доступ или токен может быть временно ограничен при:

• признаках компрометации или утечки;
• превышении лимитов или задолженности;
• нарушении правил модерации или договора;
• угрозе Сервису, пользователям или третьим лицам;
• требовании закона или поставщика критической технологии.

При возможности мы уведомим владельца интеграции и предложим устранить нарушение. Критический риск может потребовать немедленного отзыва доступа.

11. Поддержка

В обращении укажите организацию, идентификатор интеграции, время запроса, метод, код ответа и идентификатор операции. Не присылайте полный секрет, пароль, данные карты и лишний пользовательский контент.

Контакт: team@gerwin.ai.