Документация API ClipCloud

Подробная информация о использовании API генерации картинок Telegram-бота ClipCloud

## Sections
• [Основная информация](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/osnovnaya-informaciya.md): Вам не нужно добавлять API вручную, если у вас скрипт/шаблон на Zennoposter! В таком случае воспользуйтесь готовым модулем: Модуль для Zennoposter Спецификация OpenAPI - здесь . API ClipCloud крайне простой. Его использование состоит всего из трёх шагов: 1 Подготовка запроса Сначала необходимо понять, что именно вы хотите сгенерировать. Запрос крайне желательно отправлять на английском языке. ClipCloud примет запрос и на другом, в т.ч. русском языке, однако в таком случае создание картинки может производиться намного дольше, а её качество может стать хуже. Сам же запрос, в идеальном случае, должен содержать лишь информацию о том, что должно быть изображено на картинке. Тем не менее, допускается отправлять и общую информацию (например, название статьи, к которой создаются картинки), однако качество в таком случае может быть хуже. Для подобного простого указания запроса мы рекомендуем использовать стили, имеющие HQ в названии (например, FullHD-HQ-h ). Также, если вы владелец своего ПО на несколько пользователей - не забудьте воспользоваться партнёрской программой для разработчиков: вам будет начисляться 10% от трат ваших пользователей. Подробнее можно узнать в боте ClipCloud , нажав на кнопку “Для разработчиков”. 2 Отправка запроса на генерацию изображения Затем вам нужно отправить запрос на генерацию изображения. Мы рекомендуем всем пользователям использовать исключительно генерацию по стилю : в таком случае ClipCloud сам настроит за вас все необходимые параметры, связанные со стилем: от используемой нейронной сети, до количества шагов ("steps") и прочих неочевидных параметров. Расширенная генерация , в то же время, необходима в крайне редких случаях: зачастую вам не стоит тратить время на её добавление. Для максимальной скорости работы рекомендуем отправлять запрос на генерацию заранее, как только будет известно, что именно нужно сгенерировать. Следующий же этап ( получение результата генерации ) выполнять в тот момент работы вашей программы, когда изображение уже будет необходимо. 3 Получение результата генерации После этого вам необходимо получить информацию о готовности изображений. В случае их готовности на момент запроса вам будет доступны ссылки на скачивание картинок.
• [Генерация изображений](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/new-section.md): Вам не нужно добавлять API вручную, если у вас скрипт/шаблон на Zennoposter! В таком случае воспользуйтесь готовым модулем: Модуль для Zennoposter Спецификация OpenAPI - здесь . Стандартная генерация (по стилю) Идеально подходит для большинства пользователей. Вместе со стилем изменяется и используемая нейронная сеть, и размер изображения, и прочие параметры. Плюсы: Быстрый старт. Все параметры настроены заранее: невозможно ошибиться и получить “шум” вместо запрашиваемой картинки. Возможность автоматизировать выбор стиля в зависимости от запроса. Минусы: Ограниченная кастомизация стилей. Расширенная генерация Подойдёт в редких случаях. Например, если вы хотите самостоятельно настроить стиль под свои нужды. Плюсы: Возможность создать свой стиль, или же изменить существующий под свои нужды (например, изменить размер изображения). Минусы: Высокая сложность. Неочевидные параметры. Есть высокая вероятность получить “шум” вместо картинки. Если вы планируете интегрировать ClipCloud в своё ПО на несколько пользователей, мы рекомендуем интегрировать только стандартную генерацию (по стилю) .
  • [Стандартная, по стилю](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/new-section/release_createimage.md): Стандартная генерация картинок по стилю, которая рекомендуется для использования всем пользователям сервиса . В результате данного запроса вы получите ID начатой генерации. Он будет один, даже если вы укажете значение count > 1. Данный ID будет необходим для дальнейшего получения результата создания картинки или картинок. Обязательны лишь параметры prompt и style в теле запроса, а также apikey в URL запроса. POST-запрос , формат данных - application/json (как, например, и в API GPT).
  • [Расширенная, с доп. параметрами](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/new-section/standartnaya-po-stilyu-copy-1.md): Расширенная генерация картинок, которая рекомендуется для использования лишь в исключительных случаях: опытными пользователями, которые хотят настроить каждый параметр. В результате данного запроса вы получите ID начатой генерации. Он будет один, даже если вы укажете значение count > 1. Данный ID будет необходим для дальнейшего получения результата создания картинки. Обязателен лишь параметр prompt в теле запроса, а также apikey в URL запроса. Однако для получения хороших результатов при расширенной генерации, которая и рассматривается на данной странице, вам необходимо будет указать ещё как минимум model , width , height , quality . Чтобы их не указывать, и при этом достичь хорошего результата, воспользуйтесь генерацией по стилю . POST-запрос , формат данных - application/json (как, например, и в API GPT).
• [Получение результата](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/release_checkimage.md): GET-запрос . В URL запроса - ваш API-ключ и ID генерации, полученный ранее в ответе на запрос генерации изображения. В ответе - ссылка/ссылки на сгенерированные изображения (по 1 ссылке на каждое изображение).
• [Прочие запросы](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/drugie-zaprosy.md): В этой категории расположены прочие запросы, которые могут быть полезны (но совсем не обязательны) в программах в некоторых случаях. Проверка баланса API-ключа Получение доступных стилей
  • [Проверка баланса](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/drugie-zaprosy/dostupnye-stili-copy-1.md): GET-запрос . В URL запроса - ваш API-ключ. В ответе - информация о балансе этого API-ключа.
  • [Доступные стили](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/drugie-zaprosy/poluchenie-rezultata-copy-1.md): GET-запрос . В URL запроса - ваш API-ключ. В ответе - актуальная информация о существующих стилях. Более подробную информацию о стилях, с понятными названиями и описанием, вы можете найти на странице генерации по стилю , в информации о параметре “styleName”.
• [Пример использования API](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/primer-ispolzovaniya.md): Здесь расположены примеры использования API в различных ситуациях: Для генерации картинок к статье (в том числе для автоматически генерируемых при помощи сторонних ИИ статей) Для генерации картинок по заранее известному запросу (стандартный способ использования)
  • [Для генерации картинок по заранее известному запросу](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/primer-ispolzovaniya/dlya-generacii-kartinok-po-zaranee-izvestnomu-zaprosu.md): Данный API крайне простой для добавления и использования. Для создания картинки и получения результата вам необходимо выполнить лишь: Один POST-запрос с двумя параметрами; Один GET-запрос с одним параметром. Даже если вы используете минимальное количество параметров, как и указано здесь, качество изображений будет отличным в большинстве случаев. Предположим, вам необходимо сгенерировать одну картинку на запрос “ A close-up shot of a perfectly ripe red apple ”. При этом вы хотите получить качественное и реалистичное изображение, поэтому выбрали стиль HD-HQ (полный список стилей можно посмотреть в документации запроса , параметре styleName ). Вам необходимо отправить POST-запрос по URL: https://clipcloud.clipai.pro/api/creation?apikey=ВАШ_API_КЛЮЧ Если у вас появляется ошибка 415 , используйте тип данных application/json . Такой же тип данных используется, например, в запросах с API GPT. Например, в Zennoposter в блоке POST-запроса это можно сделать так: Либо вы можете добавить заголовок "Content-Type": "application/json" . В теле запроса укажите: JSON { "prompt": "A close-up shot of a perfectly ripe red apple", "styleName": "standard" } Если вы хотите заработать на запросах пользователей вашей программы - не забудьте также добавить в этот запрос параметр “soft_id”, значением которого будет число, указанное в разделе “Для разработчиков” Telegram-бота ClipCloud . Например, "soft_id": 1742 Вы получите ответ вида: Plain text { "success": true, "creation_id": "12345678-abcd-ef12-3456-7890abcdef12" } Из ответа сохраните значение параметра creation_id : он пригодится в следующем запросе на получение результата. Данный параметр всегда один на каждый запрос генерации, вне зависимости от того, сколько изображений было запрошено параметром count в одном запросе. Сразу после этого картинка начнёт генерироваться. В любой момент вы можете проверить процесс генерации, отправив GET-запрос по URL: https://clipcloud.clipai.pro/api/creation/ID_ГЕНЕРАЦИИ?apikey=ВАШ_API_КЛЮЧ Если картинка ещё генерируется, то вы получите ответ вида: {"success":true,"message":"In progress","creation_id":"12345678-abcd-ef12-3456-7890abcdef12"} А если уже сгенерирована, то: Plain text { "success": true, "message": "Images processed succesfully", "creation_id": "12345678-abcd-ef12-3456-7890abcdef12", "cost": 2.2, "censored": 0, "results": [ "https://clipcloud.clipai.pro/images/326432e4661c42d709432284c836d410b54326cf4b2d52efe549e016ca8db950.webp", "https://clipcloud.clipai.pro/images/c9436e4e57c1d9b2eb81b48d85a98a88c102f4c585ad00392fadb633ba908a98.webp" ] } В ответе на данный запрос, при успешной генерации, вы получите временные ссылки на скачивание сгенерированных изображений. Они будут в формате “WebP”, который обеспечивает хорошее сжатие, и отлично подходит как для использования в интернете, так и для локального использования практически в любых задачах.
  • [Для генерации картинок к статье](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud/primer-ispolzovaniya/dlya-generacii-kartinok-k-state.md): Если вы генерируете картинки или иллюстрации к статье (в том числе если текст пишет другой ИИ: например, GPT), вы можете отправлять лишь название статьи в запрос на создание картинок. Однако зачастую результат будет лучше, если подробно описать в запросе, что именно должно быть на изображении. Очевидно, это сложно сделать вручную. Поэтому, если в вашем ПО уже подключена какая-либо нейронная сеть для написания текста, мы рекомендуем сначала отправить запрос на описание картинок: Пример запроса на описание картинок You are an assistant who gives the result of the task execution strictly in the specified form. Your goal is to select a prompt and parameters for generating images using another AI. To do this, you need to describe what and how should be depicted in the picture or photograph. At the same time, your entire output must be in English, regardless of the input language. Avoid using text on images or image requests where the neural network might add text, letters, or digits. Use high-quality styles if the image should contain, for example, a person or many different complex objects. Specify queries so that they should not generate prohibited content: eg NSFW. Use specific styles only if you feel it is necessary for this particular article. You have been given the title of the article or query: " Название статьи ". You need to generate необходимое количество изображений picture prompts, outputting the result as a single valid JSON array. Each element of the array must be a JSON object with the following structure: {"picture_number": 1, "query": "describe here what should be in the picture", "negative_prompt": "here describe what could theoretically appear with such a request, but at the same time should clearly not be in the picture according to your idea. This parameter is optional", "style": “select a style from: standard,smallHQ,HD-HQ,FullHD-HQ-h,FullHD-HQ-v,graffiti,illustration,oldphoto,aquarelle,pixel-art,pop-art,tilt-shift,HQ-768-512-h,HQ-832-448-h,HQ-832-640-h,HQ-1024-640-h,HQ-1200-640-h,HQ-1280-720-h,HQ-512-768-v,HQ-640-1024-v”} Таким образом, будет решено сразу несколько задач: Будет написано качественное описание для каждого изображения. Будет автоматически выбран стиль изображения. Запрос будет на английском языке, вне зависимости от того, на каком языке написано название статьи. Если необходимо несколько изображений, то каждое из них будет разным, как и при ручном подборе иллюстраций к статье. При желании вы можете отредактировать указанный выше запрос по своему усмотрению: например, если вам удобнее работать не с JSON-ответом. После этого сразу же отправляйте запрос на создание изображений , даже если сама статья ещё не сгенерирована или не написана: так можно будет максимально быстро получить ответ, как только он станет необходим. И уже после написания/генерации статьи скачайте сгенерированные изображения . Здесь можно посмотреть конкретные примеры запросов на создание и получение созданных картинок.