API overview

Welcome to our API reference. Use our APIs to integrate Stable Diffusion WebUI and ComfyUI environments. This lets you quickly build your own image generation service. We provide solutions for interacting with our platform through an interface or by calling the image generation service directly. This guide helps you find the APIs you need to get started.

1. Image generation session management

If you want to provide your users with a Stable Diffusion WebUI or ComfyUI environment that has an interface, you must first integrate your account system with our token-related APIs. After you attach a unique token to each of your users, you can use that token to create an image generation session for them. This generates a Stable Diffusion WebUI or ComfyUI session environment. The related APIs are divided into two parts:

• Token-related APIs: These APIs manage the token lifecycle. You must save the relationship between the created tokens and your user accounts in your database.

  • Allocate a token

  • Query token information

  • Update token configuration

• Session-related APIs: Use these APIs to create and manage session environments that correspond to tokens.

  • Create a session

  • Refresh a session

  • Create or refresh a session

  • Query session information

2. Image generation services

We offer two main types of image generation services. You can choose the method that best suits your needs:

• Standard SD APIs: Use these APIs to generate images directly with the standard Stable Diffusion service.

  • Submit a text-to-image task - sd_txt2img

  • Submit an image-to-image task - sd_img2img

  • Query image generation progress - sd_get_progress

  • Query image generation result - sd_get_result

• ComfyUI workflow APIs: If you have specific workflow requirements, you can convert your ComfyUI workflow into an API service and call it using the following APIs. For more information, see the Workflow management document.

  • Submit a workflow task - comfy_prompt

  • Query node progress information - comfy_get_progress

  • Query workflow execution result - comfy_get_result

3. Model synchronization API

If you have many models that you need to list quickly, you can use this API.