AGTCloud API Docs
РуководстваСправочник APIИнтеграции и ресурсыОбновления и помощь

Справочник API

Найдите API AGTCloud по задаче разработки и изучите endpoints, параметры, ответы и онлайн-отладку.

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

Первый вызов API

Если у вас ещё нет ключа API или вы не определили Base URL и ID модели, сначала прочитайте Быстрый старт. После базовой настройки вы можете выбрать нужный API ниже.

Основные возможности

Текст, изображения и видео — основные разделы справочника API. Для одной возможности могут быть доступны формат, совместимый с OpenAI, формат поставщика или формат асинхронных задач AGTCloud. Выбирайте по имеющемуся SDK и целевой модели.

Другие API

Выбор по форме API

Разные возможности используют разные способы передачи и получения результата. Клиент должен обрабатывать данные согласно Content-Type и типу ответа на странице endpoint.

Форма APIТипичные сценарииОбработка на клиенте
Синхронный JSONОбычный текст, Embedding, RerankРазобрать JSON после завершения запроса
Потоковый ответ SSEПотоковая генерация Chat, Responses, GeminiНепрерывно читать события до конца потока
Асинхронная задачаВидео, MidjourneyСохранить ID задачи, запрашивать статус и результат
Загрузка MultipartРедактирование изображений, транскрипция аудиоЗагрузить файлы и поля формы по требованиям endpoint
Бинарный ответЗагрузка видео или аудиоСохранить файл согласно типу медиа
WebSocketRealtimeУстановить постоянное соединение для обмена событиями

Как читать страницу endpoint

Проверьте Endpoint и аутентификацию

Проверьте Method, Path, адрес API и необходимые Header аутентификации. Общие правила приведены в Общих соглашениях.

Выберите сценарий запроса

Выберите пример, наиболее близкий к вашей задаче, затем настройте поля по Request Body, Path Parameters или Query Parameters.

Проверьте ответы и ошибки

Разбирайте результат по статусу HTTP и типу медиа. При ошибке сохраняйте обезличенные сведения и Request ID, если он присутствует в ответе, и обратитесь к Устранению неполадок.

Проверьте через Try It

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

Общие правила интеграции

  • Если вы не уверены, какой текстовый протокол выбрать, прочитайте Выбор протокола.
  • Замените MODEL_ID в примерах справочника на ID модели, фактически доступной текущему ключу API.
  • Одноимённые возможности могут поддерживать разные поля в разных моделях и протоколах; ориентируйтесь на текущий endpoint, права аккаунта и фактический ответ.
  • Производственные приложения не должны встраивать ключ API в браузерный frontend или клиентский пакет. Try It предназначен только для временной отладки; не записывайте ключ в публичные репозитории, снимки экрана или журналы.

Далее: Общие соглашения · Ключ API, Base URL и аутентификация

На этой странице