Документы Shugg

Правила использования API

Технические правила работы ключей, баланса, лимитов и обработки ошибок.

1. Ключи

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

При компрометации отключите старый ключ в кабинете и выпустите новый — это занимает несколько секунд.

На аккаунт действует общий баланс и не больше десяти активных ключей. Отдельного кошелька у ключа нет.

2. Баланс и резерв

Перед дорогим запросом резервируется прогнозная стоимость по max_tokens.

После ответа выполняется финальный расчёт по фактическим токенам, неиспользованная часть резерва возвращается.

3. Лимиты

Частотный лимит применяется по ключу. Нехватка токенов — только с общего баланса аккаунта.

При превышении возвращается ошибка rate_limit_exceeded с признаком retryable: true — запрос можно безопасно повторить.

4. Ошибки

Основные коды: invalid_api_key, insufficient_quota, model_not_found, rate_limit_exceeded, upstream_error, upstream_timeout.

Поле origin показывает источник проблемы: local, client, provider, capacity или billing.

Поле billing прямо сообщает, были ли списаны токены. Заголовок X-Request-ID подходит для обращения в поддержку.

5. Совместимость

Endpoint совместим с форматом OpenAI: достаточно заменить base URL и ключ в существующем клиенте.

Поддерживаются потоковые ответы (stream: true), системные сообщения и вызовы инструментов у моделей, где они доступны.

Документ действует с момента публикации. Актуальная версия всегда доступна на этой странице.