ClipCloud API documentation

Detailed information on using the ClipCloud Telegram bot’s image‑generation API

## Sections
• [Main Information](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/osnovnaya-informaciya.md): You don’t need to add the API manually if you already have a script/template for ZennoPoster! In that case, use the ready‑made module: Module for Zennoposter OpenAPI specification is here . The ClipCloud API is extremely simple. Using it involves just three steps: 1 Preparing the request First, you need to decide exactly what you want to generate. It’s highly recommended to send your prompt in English. Ideally, your prompt should contain only the information about what should appear in the image. However, you can also include general context (e.g. the title of the article you’re illustrating), though this may reduce quality. For simple prompts like that, we recommend using any style with HQ in its name (for example, FullHD-HQ-h ). If you’re a software owner , don’t forget to join our developer affiliate program: you’ll earn 10% of your users’ spending. Learn more in the ClipCloud bot by clicking “For Developers”. 2 Sending the generation request Next, you send the image‑generation request. We recommend all users stick to generation by style : ClipCloud will automatically configure all the necessary parameters—everything from the neural network to the number of steps and other non‑obvious settings. Advanced generation is needed only in very rare cases; most of the time there’s no need to spend time on it. For maximum speed, we recommend sending the generation request in advance, as soon as you know exactly what needs to be generated. Then, perform the next step ( retrieving the generation result ) at the point in your program’s workflow when the image is actually needed. 3 Retrieving the results Finally, check whether the images are ready . If they’re complete at the time of your query, you’ll immediately get download links for your images.
• [Image Generation](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/new-section.md): You don’t need to add the API manually if you already have a script or template for ZennoPoster! In that case, use the ready‑made module: Module for Zennoposter OpenAPI specification is here . Standard generation (by style) Ideal for most users. Choosing a style also configures the neural network, image dimensions, and other settings. Pros: Quick to get started. All parameters are pre‑set: you won’t get “noise” instead of your requested image by mistake. You can automate style selection based on the prompt. Cons: Limited style customization. Advanced generation Useful only in rare cases — for example, if you need to fine‑tune a style for your specific requirements. Pros: Ability to create your own style or modify an existing one (e.g., change the image size). Cons: High complexity. Parameters aren’t always intuitive. Greater risk of ending up with “noise” instead of a usable image. If you plan to integrate ClipCloud into your software for multiple users, we recommend using only standard generation (by style) .
  • [Standard (by style)](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/new-section/release_createimage.md): Standard image generation by style, recommended for all service users. As a result of this request, you will receive the ID of the started generation. It will be one, even if you specify count > 1. This ID will be needed later to obtain the result of creating the image or images. Only the prompt and style parameters in the request body, as well as apikey in the request URL, are mandatory. POST request , data format – application/json (as, for example, in the GPT API).
  • [Advanced (with additional parameters)](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/new-section/standartnaya-po-stilyu-copy-1.md): Advanced image generation, recommended only in exceptional cases: for experienced users who want to configure every parameter. As a result of this request you will receive the ID of the started generation. It will be one, even if you specify count > 1. You will need this ID later to obtain the result of creating the image. Only the prompt parameter in the request body and apikey in the request URL are mandatory. However, to obtain good results with advanced generation (described on this page) you will also need to specify at least model , width , height , and quality . If you prefer not to specify them yet still achieve good results, use style‑based generation instead. POST request , data format – application/json (as, for example, in the GPT API).
• [Obtaining Results](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/release_checkimage.md): GET request . In the request URL — your API key and the generation ID obtained earlier in the image‑generation request response. The response contains the link(s) to the generated images (one link per image).
• [Other Requests](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/drugie-zaprosy.md): In this category you’ll find miscellaneous requests that may be useful (but are not mandatory) in certain program workflows: Checking the API-key balance Retrieving available styles
  • [Balance Inquiry](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/drugie-zaprosy/dostupnye-stili-copy-1.md): GET request . The API key is in the request URL. The response contains information about that API key’s balance.
  • [Available Styles](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/drugie-zaprosy/poluchenie-rezultata-copy-1.md): GET request . The API key is in the request URL. The response contains up‑to‑date information about existing styles. More detailed information about the styles, with clear names and descriptions, can be found on the style‑based generation page , in the description of the “styleName” parameter.
• [API Usage Example](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/primer-ispolzovaniya.md): Here are examples of using the API in various scenarios: For generating images for an article (including those automatically generated by third‑party AI) For generating images from a predefined prompt (the standard usage method)
  • [For generating images from a predefined prompt](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/primer-ispolzovaniya/dlya-generacii-kartinok-po-zaranee-izvestnomu-zaprosu.md): The API is extremely simple to integrate and use. To create an image and obtain the result you only need to perform: • One POST request with two parameters; • One GET request with one parameter. Even if you use the minimum number of parameters, as shown here, image quality will be excellent in most cases. Assume you need to generate one image for the prompt “A close‑up shot of a perfectly ripe red apple.” Because you want a high‑quality, realistic picture, you choose the HD‑HQ style (the full list of styles can be found in the request documentation , parameter styleName ). Send a POST request to: https://clipcloud.clipai.pro/api/creation?apikey=YOUR_API_KEY If you receive a 415 error , set the data type to application/json . The same data type is used, for example, in GPT‑API requests. Or add the header: "Content-Type": "application/json" . In the request body specify: JSON { "prompt": "A close-up shot of a perfectly ripe red apple", "styleName": "standard" } If you want to earn money on the requests made by users of your software, add the soft_id parameter as well. Its value is the number shown in the “For Developers” section of the Telegram-bot ClipCloud . For example, "soft_id": 1742 You will receive a response like this: Plain text { "success": true, "creation_id": "12345678-abcd-ef12-3456-7890abcdef12" } Save the creation_id value; you’ll need it in the next request to obtain the result. This parameter is always unique per generation request, regardless of how many images were requested via count. Immediately after that, the image starts generating. At any time you can check the generation progress by sending a GET request to: https://clipcloud.clipai.pro/api/creation/GENERATION_ID?apikey=YOUR_API_KEY If the image is still being generated, you’ll get a response like: {"success":true,"message":"In progress","creation_id":"12345678-abcd-ef12-3456-7890abcdef12"} And once it has been generated: 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" ] } In the successful response you will receive temporary links for downloading the generated images. They are provided in WebP format, which offers good compression and is well suited both for web use and for almost any local use case.
  • [For generating images for an article](https://app.theneo.io/1503fe86-2db1-43ac-880a-cbf661919292/clipcloud-clone/primer-ispolzovaniya/dlya-generacii-kartinok-k-state.md): If you are generating images or illustrations for an article (including when the text is written by another AI such as GPT), you can submit only the article title in the image‑creation request. However, the result is usually better if you describe in detail what exactly should appear in the image. Doing this manually is obviously difficult. Therefore, if your software already connects to a neural network that writes text, we recommend first sending a request for image descriptions: Example request for image descriptions 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: " Article name ". You need to generate image count 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”} Thus, several tasks are solved at once: A quality description is written for each image. The image style is selected automatically. The request is in English, regardless of the language of the article title. If multiple images are required, each one will differ, just as when illustrations are manually selected for the article. If you wish, you can edit the above prompt to suit your needs—for example, if it is more convenient for you not to work with a JSON response. After that, immediately send the image‑creation request , even if the article itself has not yet been generated or written; this lets you obtain the answer as quickly as possible when it is needed. Once the article is written or generated, download the generated images . Here you can find specific examples of requests for creating images and retrieving the generated pictures.