БАЗА ЗНАНИЙ

Справочник API

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

Просмотреть как Markdown

Начните здесьВыберите подходящий API и разберитесь в общих ошибках.РазработчиковАвторизация приложений, лимиты расходов клиентов, восстановление биллинга и интеграция инференса.ПровайдеровУправляйте каталогами провайдеров и ценами, затем контролируйте отдельные устройства.СоздателейАутентификация создателей, коллекции, пакеты моделей и теги.

Сделайте первый запрос к API

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

Выберите подходящий API и учетные данные

Найдите конечные точки API ShareAI для авторизации приложений, чата, ответов, встраиваний, изображений, Провайдеров, Устройств и Создателей с правильным URL и учетными данными.

Зарегистрируйте ваше приложение

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

Авторизуйте аккаунт с помощью PKCE

Используйте код авторизации плюс S256 PKCE для конфиденциальных и публичных приложений.

Выберите области Login, Pay и AI

Вход, оплата продуктов и дополнительные сборы за использование AI требуют отдельных функций и авторизации клиента.

Обновить токен доступа

Обновляйте токены обновления без расширения разрешенных клиентом областей.

Читайте идентификацию и находите конечные точки авторизации

Используйте обнаружение ShareAI Auth, JWKS и UserInfo для проверки входа в приложение и чтения идентичности, разрешенной токеном доступа OAuth.

Отмените токены и проверьте авторизацию на стороне сервера

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

Понять принятые соглашения о выставлении счетов

Удерживайте цену подписки, интервал и дополнительный сбор за AI в соответствии с условиями, принятыми каждым клиентом.

Создайте завершение чата

Отправьте запрос на завершение чата ShareAI с ключом API Bearer и ознакомьтесь с поддерживаемой моделью, сообщениями и полями потока.

Отправляйте запросы чата с OAuth

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

Передавайте потоковый ответ чата

Читайте события серверной отправки ShareAI chat-completions, добавляйте дельты контента один раз и обрабатывайте завершение, ошибки и прерванные потоки.

Проверяйте доступ к ключам и идентификацию учетной записи

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

Создать текстовый ответ

Используйте API ответов ShareAI для генерации текста без сохранения состояния, явной истории разговоров и событий потоковой передачи ответов.

Создать текстовые встраивания

Сгенерируйте текстовые встраивания с ShareAI для семантического поиска, извлечения и сходства с поддерживаемыми форматами ввода и требованиями к моделям.

Сгенерировать изображение

Создавайте изображения с помощью ShareAI Images API, используя поддерживаемую модель, текстовый запрос и проверенные параметры генерации изображений.

Аутентифицируйте API провайдера

Включите удаленный доступ провайдера и используйте UUID провайдера и токен доступа с ограниченной областью для запросов каталога и цен.

Список моделей провайдера и сети

Прочитайте каталог сети ShareAI Provider API, каталог вашего провайдера и точные детали модели, используя provider_models:read.

Обновляйте цены моделей провайдера

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

Аутентифицируйте API устройства

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

Читайте сеансы устройства и историю задач

Список сеансов устройств ShareAI и проверка истории задач сеанса с использованием токена удаленного управления, специфичного для устройства.

Запускайте и останавливайте совместное использование устройства

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

Аутентифицируйте API создателя

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

Читайте и управляйте коллекциями моделей

Список, создание и обновление коллекций моделей ShareAI Creator с необходимыми областями и четкими границами владения и проверки.

Создайте пакет модели

Создайте метаданные модели ShareAI Creator, коллекцию и теги модели вместе с явной политикой доступа и ограниченными API-учетными данными.

Управляйте моделями в коллекции

Список, чтение, создание и обновление тегов модели ShareAI Creator, сохраняя их принадлежность коллекции и эффективную политику обслуживания.

Обрабатывайте ошибки API и повторные попытки

Диагностика ошибок аутентификации, области действия, доступа к модели и доступности ShareAI без дублирования записей или небезопасных повторных попыток обновления.

Понять создателей моделей, идентификаторы и теги

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

Выбрать исполнителей для API-запроса

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

Справочник по политике провайдеров

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

Сортировать провайдеров и управлять резервным механизмом

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

Поймите идентичности клиентов

Каждый OAuth-клиент получает уникальный идентификатор для одного и того же клиента ShareAI.

Оплата продуктов и подписок

Создайте оформление кошелька, дайте клиенту подтвердить его в ShareAI, затем проверьте оплаченный результат перед выполнением.

Устранение ошибок выставления счетов и ограничений расходов клиентов

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