Skip to main content
POST
cURL
API v1 is deprecated. This version is no longer being developed — new endpoints, parameters and models are added to v2 only. Use the v2 endpoints to stay current: v2 API documentation.
Prerequisite: To ensure a successful request, you must first consult the Model Selection endpoint to identify a valid model slug, check specific limits and features, and verify LoRA availability. Please omit the LoRA parameter by default during initial testing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
enum<string>
default:application/json
required
Available options:
application/json

Body

multipart/form-data

Image generation parameters. Either "image" or "images[]" must be provided (not both).

image
file
required

Single source image to edit. Required if "images[]" is not provided. Mutually exclusive with "images[]". Supported formats: JPG, JPEG, PNG, GIF, BMP, WebP. Maximum file size: 10 MB.

prompt
string
required

The main prompt for image generation

Example:

"A beautiful sunset over mountains"

model
string
required

The model to use for image editing. Available models can be retrieved via the GET /api/v1/client/models endpoint.

Example:

"QwenImageEdit_Plus_NF4"

steps
integer
required

Number of inference steps. The accepted range is model-specific - read info.limits.min_steps / info.limits.max_steps for your model from the Model Selection endpoint before sending the request; a value outside that range is rejected with 422. For the example model QwenImageEdit_Plus_NF4 the allowed range is 1-50 (default 40).

Required range: x >= 1
Example:

20

seed
integer
required

Random seed for generation

Example:

42

negative_prompt
string | null

Elements to avoid in the generated image

Example:

"blur, darkness, noise"

width
integer | null

Output image width in pixels. Optional - defaults to first input image width if not specified. Subject to model-specific min/max limits.

Example:

512

height
integer | null

Output image height in pixels. Optional - defaults to first input image height if not specified. Subject to model-specific min/max limits.

Example:

512

loras
object[]

Array of LoRA models to apply

guidance
number

Guidance scale for the generation

Example:

7.5

webhook_url
string<uri> | null

Optional HTTPS URL to receive webhook notifications for job status changes (processing, completed, failed). Must be HTTPS. Max 2048 characters. See Webhook Documentation for payload structure and authentication details.

Maximum string length: 2048
Example:

"https://your-server.com/webhooks/deapi"

Response

ID of the inference request.

data
object

Information from success endpoint