Alibaba Z-Image — Inpainting

Generate images from text, an image and a mask using Z-Image Turbo, Tongyi-MAI's super-fast 6B model.

Input

Add your inputs and customize the generation settings.

The prompt to generate an image from.
Upload, drag and drop, or paste a public URL.
Selected image

URL of Image for Inpaint generation.
Upload, drag and drop, or paste a public URL.
Selected image

URL of Mask for Inpaint generation.

Customize your input with more control.

Calculate credits for your selected settings before generating.

Result & Pricing

Image output — your generated image will appear here.

Your image will appear here

Choose your inputs and customize your settings.

Model pricing (tax excluded) per processed image megapixel

SpecificationWebot INR
Rate₹1.20
Prompt expansion / request (additional)₹0.30
Calculate credits in the input panel for your selected settings.

Prices, estimates and credit deductions exclude tax. Any applicable tax is charged only when you buy plans or credits.

Prices are converted to INR. Credits use your current plan rate.

  • Prices shown are estimates, not final charges. Final billing details will be available in Reports after generation is complete.

API

WEBOT API · Inpainting

Generate from your server with your WEBOT account credits.

Use your 120-character WEBOT customer key (a–z, A–Z, 0–9). Send Authorization: Bearer YOUR_KEY. Keys are secrets: call from a server, never from public frontend code. Results come from verified webhooks and remain saved if your stream disconnects.
1. Configure your server
WEBOT_BASE_URL=https://webot.online
WEBOT_API_KEY=<your-server-side-WEBOT-key>

This base URL is resolved from verified domain mappings and your direct creator reseller. Forwarded Host headers are not trusted. New custom reseller domains need DNS, TLS and platform verification before activation.

2. Quote, then generate
MethodEndpointPurpose
POSThttps://webot.online/api/v1/models/alibaba_z_image_turbo_inpaint/quoteValidate input and calculate credits (no deduction).
POSThttps://webot.online/api/v1/models/alibaba_z_image_turbo_inpaint/requestsReserve quoted credits and queue an asynchronous job.
GEThttps://webot.online/api/v1/models/alibaba_z_image_turbo_inpaint/requests/{request_id}/resultRead your saved result: 202 pending, 200 terminal.
GEThttps://webot.online/api/v1/models/alibaba_z_image_turbo_inpaint/requests/{request_id}/eventsAuthenticated SSE: generation / terminal events.

Send JSON {"input":{…}} to quote. Send the same input plus integer quoted_credits to generate, with Authorization: Bearer … and Idempotency-Key. Use a unique 16–128 character key per new job; persist it and reuse the same key and input on any uncertain response. Never retry with a new key: that creates a second chargeable job.

Credits are reserved only after validation and a durable request is saved. A changed quote or insufficient balance returns 409. Credits exclude purchase taxes. The quoted amount is an initial reservation. After generation, the final charge replaces it using confirmed usage. Any verified unused allocation becomes available automatically; additional usage may require more credits. Missing billing stays pending, including for failed jobs.

3. Input example

Save this as input.json. Replace sample prompts, files and media URLs with your own. Schemas do not guarantee provider acceptance of the content.

Supported generation options
  • Choose explicit output dimensions; automatic sizing is unavailable for an accurate quote.
{
    "prompt": "Audit sample text",
    "image_url": "https://example.com/source.png",
    "mask_image_url": "https://example.com/source.png",
    "image_size": {
        "width": 1024,
        "height": 1024
    },
    "enable_prompt_expansion": false,
    "num_inference_steps": 8,
    "control_end": 0.8,
    "enable_safety_checker": true,
    "control_scale": 0.75,
    "output_format": "png",
    "num_images": 1,
    "sync_mode": false,
    "control_start": 0,
    "strength": 1,
    "acceleration": "regular"
}
4. Language examples
# Save the model's example input as input.json, then replace prompts/media URLs.
# Requires curl and jq. Store NONCE once for this job; reuse it on any retry.
export NONCE="$(openssl rand -hex 16)"
BASE="${WEBOT_BASE_URL%/}"
jq -n --slurpfile input input.json '{input:$input[0]}' > quote-body.json
curl --fail-with-body -sS "$BASE/api/v1/models/alibaba_z_image_turbo_inpaint/quote" \
  -H "Authorization: Bearer $WEBOT_API_KEY" -H 'Content-Type: application/json' \
  --data-binary @quote-body.json > quote.json
CREDITS=$(jq -er '.quote.credits_consumed' quote.json)
jq --argjson credits "$CREDITS" '. + {quoted_credits:$credits}' quote-body.json > request-body.json
curl --fail-with-body -sS "$BASE/api/v1/models/alibaba_z_image_turbo_inpaint/requests" \
  -H "Authorization: Bearer $WEBOT_API_KEY" -H "Idempotency-Key: $NONCE" \
  -H 'Content-Type: application/json' --data-binary @request-body.json > job.json
# Subscribe; after a nonterminal disconnect, reconnect this SAME URL.
curl --fail-with-body -N "$(jq -er '.events_url' job.json)" -H "Authorization: Bearer $WEBOT_API_KEY"
# Read saved output after terminal notification (never call provider status/results).
curl --fail-with-body -sS "$(jq -er '.result_url' job.json)" -H "Authorization: Bearer $WEBOT_API_KEY"
// Node.js 18+. Save your customized input in input.json.
import { readFileSync } from 'node:fs';
import { randomUUID } from 'node:crypto';
const base = process.env.WEBOT_BASE_URL.replace(/\/$/, '');
const key = process.env.WEBOT_API_KEY;
const input = JSON.parse(readFileSync('input.json', 'utf8'));
const nonce = process.env.WEBOT_JOB_NONCE || randomUUID(); // Persist before submission.
async function post(path, body, nonce) {
  const response = await fetch(base + path, {method:'POST', headers:{
    Authorization:`Bearer ${key}`, 'Content-Type':'application/json',
    ...(nonce ? {'Idempotency-Key':nonce} : {})}, body:JSON.stringify(body)});
  const json = await response.json();
  if (!response.ok) throw new Error(JSON.stringify(json));
  return json;
}
const {quote} = await post('/api/v1/models/alibaba_z_image_turbo_inpaint/quote', {input});
const job = await post('/api/v1/models/alibaba_z_image_turbo_inpaint/requests', {input, quoted_credits:quote.credits_consumed}, nonce);
console.log(job); // Stable WEBOT request_id, events_url, result_url.
// Stream saved webhook state. Reconnect ONLY the event stream, not the generation.
while (!job.terminal || job.financial_pending) {
  const stream = await fetch(job.events_url, {headers:{Authorization:`Bearer ${key}`}});
  if (!stream.ok) throw new Error(`Event stream HTTP ${stream.status}`);
  let buffer = '';
  for await (const chunk of stream.body.pipeThrough(new TextDecoderStream())) {
    buffer += chunk;
    let end;
    while ((end = buffer.indexOf('\n\n')) !== -1) {
      const event = buffer.slice(0, end); buffer = buffer.slice(end + 2);
      const data = event.split('\n').find(line => line.startsWith('data: '));
      if (!data) continue;
      const state = JSON.parse(data.slice(6));
      if (state.error && !state.status) throw new Error(JSON.stringify(state.error));
      if (state.terminal && !state.financial_pending) { console.log(state.output ?? state.error); process.exit(0); }
    }
  }
  await new Promise(resolve => setTimeout(resolve, 1500));
}
console.log(job.output ?? job.error);
// Node.js 18+. Save your customized input in input.json.
import { readFileSync } from 'node:fs';
import { randomUUID } from 'node:crypto';
const base = process.env.WEBOT_BASE_URL!.replace(/\/$/, '');
const key = process.env.WEBOT_API_KEY!;
const input = JSON.parse(readFileSync('input.json', 'utf8'));
const nonce = process.env.WEBOT_JOB_NONCE || randomUUID(); // Persist before submission.
async function post(path: string, body: unknown, nonce?: string) {
  const response = await fetch(base + path, {method:'POST', headers:{
    Authorization:`Bearer ${key}`, 'Content-Type':'application/json',
    ...(nonce ? {'Idempotency-Key':nonce} : {})}, body:JSON.stringify(body)});
  const json = await response.json();
  if (!response.ok) throw new Error(JSON.stringify(json));
  return json;
}
const {quote} = await post('/api/v1/models/alibaba_z_image_turbo_inpaint/quote', {input});
const job = await post('/api/v1/models/alibaba_z_image_turbo_inpaint/requests', {input, quoted_credits:quote.credits_consumed}, nonce);
console.log(job); // Stable WEBOT request_id, events_url, result_url.
// Stream saved webhook state. Reconnect ONLY the event stream, not the generation.
while (!job.terminal || job.financial_pending) {
  const stream = await fetch(job.events_url, {headers:{Authorization:`Bearer ${key}`}});
  if (!stream.ok) throw new Error(`Event stream HTTP ${stream.status}`);
  let buffer = '';
  for await (const chunk of stream.body.pipeThrough(new TextDecoderStream())) {
    buffer += chunk;
    let end;
    while ((end = buffer.indexOf('\n\n')) !== -1) {
      const event = buffer.slice(0, end); buffer = buffer.slice(end + 2);
      const data = event.split('\n').find(line => line.startsWith('data: '));
      if (!data) continue;
      const state = JSON.parse(data.slice(6));
      if (state.error && !state.status) throw new Error(JSON.stringify(state.error));
      if (state.terminal && !state.financial_pending) { console.log(state.output ?? state.error); process.exit(0); }
    }
  }
  await new Promise(resolve => setTimeout(resolve, 1500));
}
console.log(job.output ?? job.error);
# Python 3.9+, pip install requests
import json, os, time, uuid, requests
base = os.environ['WEBOT_BASE_URL'].rstrip('/')
headers = {'Authorization': 'Bearer ' + os.environ['WEBOT_API_KEY']}
with open('input.json', encoding='utf-8') as file:
    input_data = json.load(file)
nonce = os.environ.get('WEBOT_JOB_NONCE') or str(uuid.uuid4()) # Persist before submitting.
def post(path, body, extra=None):
    response = requests.post(base + path, headers={**headers, **(extra or {})}, json=body, timeout=180)
    response.raise_for_status()
    return response.json()
quote = post('/api/v1/models/alibaba_z_image_turbo_inpaint/quote', {'input': input_data})['quote']
job = post('/api/v1/models/alibaba_z_image_turbo_inpaint/requests', {'input': input_data, 'quoted_credits': quote['credits_consumed']}, {'Idempotency-Key': nonce})
state = job
while not state['terminal'] or state.get('financial_pending', False):
    # Reconnect while nonterminal; this reads WEBOT's database, never a provider status API.
    with requests.get(job['events_url'], headers=headers, stream=True, timeout=(10, 40)) as stream:
        stream.raise_for_status()
        for line in stream.iter_lines(decode_unicode=True):
            if line and line.startswith('data: '):
                state = json.loads(line[6:])
                if 'status' not in state: raise RuntimeError(state)
                if state['terminal'] and not state.get('financial_pending', False): break
    if not state['terminal'] or state.get('financial_pending', False): time.sleep(1.5)
print(state['output'] if state['status'] == 'completed' else state['error'])
<?php // PHP 8.1+ with cURL
$base = rtrim(getenv('WEBOT_BASE_URL'), '/');
$input = json_decode(file_get_contents('input.json'), false, 64, JSON_THROW_ON_ERROR);
$nonce = getenv('WEBOT_JOB_NONCE') ?: bin2hex(random_bytes(16)); // Persist this before submission.
function post(string $path, array $body, ?string $nonce = null): array {
    global $base;
    $headers = ['Authorization: Bearer '.getenv('WEBOT_API_KEY'), 'Content-Type: application/json'];
    if ($nonce) $headers[] = 'Idempotency-Key: '.$nonce;
    $ch = curl_init($base.$path);
    curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER=>true, CURLOPT_POST=>true,
        CURLOPT_TIMEOUT=>180, CURLOPT_HTTPHEADER=>$headers,
        CURLOPT_POSTFIELDS=>json_encode($body, JSON_THROW_ON_ERROR)]);
    $raw = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch);
    if ($raw === false || $status < 200 || $status >= 300) throw new RuntimeException('WEBOT HTTP '.$status);
    return json_decode($raw, true, 64, JSON_THROW_ON_ERROR);
}
$quote = post('/api/v1/models/alibaba_z_image_turbo_inpaint/quote', ['input'=>$input])['quote'];
$job = post('/api/v1/models/alibaba_z_image_turbo_inpaint/requests', ['input'=>$input, 'quoted_credits'=>$quote['credits_consumed']], $nonce);
echo json_encode($job, JSON_PRETTY_PRINT); // Connect to events_url with the same Bearer header.
// Go 1.20+; save as main.go.
package main
import ("bytes"; "encoding/json"; "fmt"; "io"; "net/http"; "os"; "strings"; "time"; "crypto/rand"; "encoding/hex")
func main() {
    base := strings.TrimRight(os.Getenv("WEBOT_BASE_URL"), "/")
    raw, err := os.ReadFile("input.json"); if err != nil { panic(err) }
    nonce := os.Getenv("WEBOT_JOB_NONCE")
    if nonce == "" { b := make([]byte,16); if _,err:=rand.Read(b);err!=nil {panic(err)}; nonce=hex.EncodeToString(b) }
    // Persist nonce before the submission; reuse on ambiguous responses.
    client := &http.Client{Timeout:180*time.Second}
    post := func(path string, body any, id string) map[string]any {
        data, err := json.Marshal(body); if err != nil {panic(err)}
        req, err := http.NewRequest("POST",base+path,bytes.NewReader(data)); if err!=nil {panic(err)}
        req.Header.Set("Authorization","Bearer "+os.Getenv("WEBOT_API_KEY")); req.Header.Set("Content-Type","application/json")
        if id!="" {req.Header.Set("Idempotency-Key",id)}
        res,err:=client.Do(req); if err!=nil {panic(err)}; defer res.Body.Close()
        data,err=io.ReadAll(res.Body); if err!=nil {panic(err)}
        if res.StatusCode<200||res.StatusCode>=300 {panic(string(data))}
        var result map[string]any; if err=json.Unmarshal(data,&result);err!=nil {panic(err)}; return result
    }
    input:=json.RawMessage(raw)
    quote:=post("/api/v1/models/alibaba_z_image_turbo_inpaint/quote",map[string]any{"input":input},"")["quote"].(map[string]any)
    job:=post("/api/v1/models/alibaba_z_image_turbo_inpaint/requests",map[string]any{"input":input,"quoted_credits":quote["credits_consumed"]},nonce)
    fmt.Println(job) // Stream events_url with the same Authorization header.
}
// Java 11+, Jackson databind dependency; class Main in Main.java.
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.time.Duration;
import java.util.UUID;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.node.ObjectNode;
public class Main {
  static final ObjectMapper json = new ObjectMapper();
  static final HttpClient client = HttpClient.newHttpClient();
  static final String base = System.getenv("WEBOT_BASE_URL").replaceAll("/$", "");
  static JsonNode post(String path, JsonNode body, String nonce) throws Exception {
    var b = HttpRequest.newBuilder(URI.create(base+path)).timeout(Duration.ofSeconds(180))
      .header("Authorization","Bearer "+System.getenv("WEBOT_API_KEY")).header("Content-Type","application/json")
      .POST(HttpRequest.BodyPublishers.ofString(json.writeValueAsString(body)));
    if(nonce!=null)b.header("Idempotency-Key",nonce);
    var r=client.send(b.build(),HttpResponse.BodyHandlers.ofString());
    if(r.statusCode()<200||r.statusCode()>=300)throw new IllegalStateException(r.body());
    return json.readTree(r.body());
  }
  public static void main(String[] args) throws Exception {
    var input=json.readTree(Files.readString(Path.of("input.json")));
    ObjectNode body=json.createObjectNode();body.set("input",input);
    var quote=post("/api/v1/models/alibaba_z_image_turbo_inpaint/quote",body,null).get("quote");
    body.put("quoted_credits",quote.get("credits_consumed").asInt());
    String nonce=System.getenv("WEBOT_JOB_NONCE");if(nonce==null)nonce=UUID.randomUUID().toString(); // Persist before POST.
    var job=post("/api/v1/models/alibaba_z_image_turbo_inpaint/requests",body,nonce);System.out.println(job);
    // Subscribe to job.events_url with Authorization; use BodyHandlers.ofLines().
  }
}
// .NET 8 console app, top-level statements.
using System.Net.Http;
using System.Text;
using System.Text.Json.Nodes;
var client = new HttpClient { Timeout = TimeSpan.FromSeconds(180) };
var root = Environment.GetEnvironmentVariable("WEBOT_BASE_URL")!.TrimEnd('/');
var key = Environment.GetEnvironmentVariable("WEBOT_API_KEY");
async Task<JsonNode> Post(string path, JsonNode body, string? nonce = null) {
    using var req = new HttpRequestMessage(HttpMethod.Post, root + path);
    req.Headers.Add("Authorization", "Bearer " + key);
    if (nonce != null) req.Headers.Add("Idempotency-Key", nonce);
    req.Content = new StringContent(body.ToJsonString(), Encoding.UTF8, "application/json");
    using var res = await client.SendAsync(req);
    var raw = await res.Content.ReadAsStringAsync();res.EnsureSuccessStatusCode();
    return JsonNode.Parse(raw)!;
}
var input = JsonNode.Parse(await File.ReadAllTextAsync("input.json"));
var body = new JsonObject { ["input"] = input };
var quote = await Post("/api/v1/models/alibaba_z_image_turbo_inpaint/quote", body);
body["quoted_credits"] = quote["quote"]!["credits_consumed"]!.GetValue<int>();
var nonce = Environment.GetEnvironmentVariable("WEBOT_JOB_NONCE") ?? Guid.NewGuid().ToString(); // Persist before submitting.
var job = await Post("/api/v1/models/alibaba_z_image_turbo_inpaint/requests", body, nonce);
Console.WriteLine(job); // Subscribe to events_url with the same Bearer header and ResponseHeadersRead.
# Ruby 3+, standard library only.
require 'net/http'
require 'json'
require 'securerandom'
base = ENV.fetch('WEBOT_BASE_URL').sub(%r{/$}, '')
post = lambda do |path, body, nonce = nil|
  uri = URI(base + path)
  req = Net::HTTP::Post.new(uri)
  req['Authorization'] = 'Bearer ' + ENV.fetch('WEBOT_API_KEY')
  req['Content-Type'] = 'application/json'
  req['Idempotency-Key'] = nonce if nonce
  req.body = JSON.generate(body)
  res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, read_timeout: 180) { |http| http.request(req) }
  raise res.body unless res.is_a?(Net::HTTPSuccess)
  JSON.parse(res.body)
end
input = JSON.parse(File.read('input.json'))
quote = post.call('/api/v1/models/alibaba_z_image_turbo_inpaint/quote', {'input' => input})['quote']
nonce = ENV['WEBOT_JOB_NONCE'] || SecureRandom.uuid # Persist this before submission.
job = post.call('/api/v1/models/alibaba_z_image_turbo_inpaint/requests', {'input' => input, 'quoted_credits' => quote['credits_consumed']}, nonce)
puts JSON.pretty_generate(job) # Subscribe to events_url with the same Authorization header.
// Swift 5.9 server-side/CLI only. Do not embed customer keys in shipped apps.
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
@main struct Main {
 static func main() async throws {
  let env=ProcessInfo.processInfo.environment
  let base=env["WEBOT_BASE_URL"]!.trimmingCharacters(in: CharacterSet(charactersIn:"/"))
  let input=try JSONSerialization.jsonObject(with: Data(contentsOf:URL(fileURLWithPath:"input.json")))
  func post(_ path:String,_ body:[String:Any],_ nonce:String?=nil) async throws -> [String:Any] {
   var req=URLRequest(url:URL(string:base+path)!);req.httpMethod="POST";req.timeoutInterval=180
   req.setValue("Bearer "+env["WEBOT_API_KEY"]!,forHTTPHeaderField:"Authorization")
   req.setValue("application/json",forHTTPHeaderField:"Content-Type")
   if let nonce {req.setValue(nonce,forHTTPHeaderField:"Idempotency-Key")}
   req.httpBody=try JSONSerialization.data(withJSONObject:body)
   let (data,res)=try await URLSession.shared.data(for:req)
   guard let http=res as? HTTPURLResponse,(200..<300).contains(http.statusCode) else {throw NSError(domain:"WEBOT",code:1)}
   return try JSONSerialization.jsonObject(with:data) as! [String:Any]
  }
  let quote=try await post("/api/v1/models/alibaba_z_image_turbo_inpaint/quote",["input":input])["quote"] as! [String:Any]
  let nonce=env["WEBOT_JOB_NONCE"] ?? UUID().uuidString // Persist before submission.
  let job=try await post("/api/v1/models/alibaba_z_image_turbo_inpaint/requests",["input":input,"quoted_credits":quote["credits_consumed"]!],nonce)
  print(job) // Subscribe to events_url with the same Authorization header.
 }
}
// Server-side Kotlin/JVM 17+, Gradle dependencies: OkHttp 4.12, org.json 20240303.
import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody
import org.json.JSONObject
import java.io.File
import java.util.UUID
import java.util.concurrent.TimeUnit
fun main() {
 val base=System.getenv("WEBOT_BASE_URL").trimEnd('/')
 val client=OkHttpClient.Builder().readTimeout(180,TimeUnit.SECONDS).build()
 fun post(path:String,body:JSONObject,nonce:String?=null):JSONObject {
  val b=Request.Builder().url(base+path).header("Authorization","Bearer "+System.getenv("WEBOT_API_KEY"))
   .post(body.toString().toRequestBody("application/json".toMediaType()))
  if(nonce!=null)b.header("Idempotency-Key",nonce)
  return client.newCall(b.build()).execute().use {res ->
   val raw=res.body!!.string();check(res.isSuccessful){raw};JSONObject(raw)
  }
 }
 val body=JSONObject().put("input",JSONObject(File("input.json").readText()))
 val quote=post("/api/v1/models/alibaba_z_image_turbo_inpaint/quote",body).getJSONObject("quote")
 body.put("quoted_credits",quote.getInt("credits_consumed"))
 val nonce=System.getenv("WEBOT_JOB_NONCE") ?: UUID.randomUUID().toString() // Persist before submission.
 val job=post("/api/v1/models/alibaba_z_image_turbo_inpaint/requests",body,nonce)
 println(job) // Subscribe to events_url with the same Authorization header.
}
5. Receive all results

The response includes a stable WEBOT request_id, events_url and result_url. Subscribe with a Bearer-authenticated HTTP stream. Nonterminal streams end after 25 seconds; reconnect to the same URL after at least 1.5 seconds. Current saved state is replayed immediately, including completion that happened while disconnected. A terminal event contains the result envelope. The JSON terminal flag describes generation completion. Keep reconnecting while financial_pending is true; stop after the terminal event confirms financial settlement. Never poll provider status/results. Native browser EventSource cannot send a Bearer header; keep the key on your server.

Completed output contains the full model result, including every generated media/document item, not just the first URL. Failed output is null with error and refund_state. Results are strictly limited to the key owner, including on reseller domains. Model-independent aliases: /api/v1/requests/{request_id}/result and /events. Revoking a key blocks subsequent reads and streams; saved results remain accessible with another valid key of the same account.

6. Schemas and parameter defaults

Required fields are marked with *. Required text must contain non-whitespace content. Defaults apply when an optional parameter is omitted; null, false, 0 and an empty array are distinct values. “No documented default” means WEBOT does not invent one. Examples are sample inputs, not defaults. WEBOT generation constraints can require an explicit value even when the provider publishes an automatic default.

Input schema · fields, constraints and defaults
ParameterTypeRequiredDefault when omittedDescription / constraints
promptstringYes *No documented defaultThe prompt to generate an image from.
enable_prompt_expansionbooleanNofalseWhether to enable prompt expansion. Note: this will increase the price by 0.0025 credits per request.
num_inference_stepsintegerNo8The number of inference steps to perform.
minimum: 1 · maximum: 8
control_endnumberNo0.8The end of the controlnet conditioning.
minimum: 0 · maximum: 1
mask_image_urlstringYes *No documented defaultURL of Mask for Inpaint generation.
enable_safety_checkerbooleanNotrueIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images.
image_sizeobject | stringNo"square_hd"The size of the generated image.
image_size.variant0.heightintegerNo512The height of the generated image.
maximum: 14142 · exclusiveMinimum: 0
image_size.variant0.widthintegerNo512The width of the generated image.
maximum: 14142 · exclusiveMinimum: 0
control_scalenumberNo0.75The scale of the controlnet conditioning.
minimum: 0 · maximum: 1
output_formatstringNo"png"The format of the generated image.
enum: ["jpeg","png","webp"]
num_imagesintegerNo1The number of images to generate.
minimum: 1 · maximum: 4
sync_modebooleanNofalseIf `True`, the media will be returned as a data URI and the output data won't be available in the request history.
control_startnumberNo0The start of the controlnet conditioning.
minimum: 0 · maximum: 1
image_urlstringYes *No documented defaultURL of Image for Inpaint generation.
strengthnumberNo1The strength of the inpaint conditioning.
maximum: 1 · exclusiveMinimum: 0
accelerationstringNo"regular"The acceleration level to use.
enum: ["none","regular","high"]
seedinteger | nullNoNo documented default The same seed and the same prompt given to the same version of the model will output the same image every time.
{
    "x-webot-order-properties": [
        "prompt",
        "image_size",
        "num_inference_steps",
        "seed",
        "sync_mode",
        "num_images",
        "enable_safety_checker",
        "output_format",
        "acceleration",
        "enable_prompt_expansion",
        "image_url",
        "control_scale",
        "control_start",
        "control_end",
        "mask_image_url",
        "strength"
    ],
    "properties": {
        "prompt": {
            "description": "The prompt to generate an image from.",
            "type": "string",
            "examples": [
                "A young Asian woman with long, vibrant purple hair stands on a sunlit sandy beach, posing confidently with her left hand resting on her hip. She gazes directly at the camera with a neutral expression. A sleek black ribbon bow is tied neatly on the right side of her head, just above her ear. She wears a flowing white cotton dress with a fitted bodice and a flared skirt that reaches mid-calf, slightly lifted by a gentle sea breeze. The beach behind her features fine, pale golden sand with subtle footprints, leading to calm turquoise waves under a clear blue sky with soft, wispy clouds. The lighting is natural daylight, casting soft shadows to her left, indicating late afternoon sun. The horizon line is visible in the background, with a faint silhouette of distant dunes. Her skin tone is fair with a natural glow, and her facial features are delicately defined. The composition is centered on her figure, framed from mid-thigh up, with shallow depth of field blurring the distant waves slightly."
            ],
            "title": "Prompt"
        },
        "enable_prompt_expansion": {
            "description": "Whether to enable prompt expansion. Note: this will increase the price by 0.0025 credits per request.",
            "type": "boolean",
            "default": false,
            "title": "Enable Prompt Expansion"
        },
        "num_inference_steps": {
            "maximum": 8,
            "description": "The number of inference steps to perform.",
            "type": "integer",
            "minimum": 1,
            "default": 8,
            "title": "Number of Inference Steps"
        },
        "control_end": {
            "maximum": 1,
            "description": "The end of the controlnet conditioning.",
            "type": "number",
            "minimum": 0,
            "default": 0.8,
            "title": "Control End"
        },
        "mask_image_url": {
            "description": "URL of Mask for Inpaint generation.",
            "type": "string",
            "examples": [
                "https://storage.googleapis.com/falserverless/whls/z-image-inpaint-mask.jpg"
            ],
            "title": "Mask Image URL"
        },
        "enable_safety_checker": {
            "description": "If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images.",
            "type": "boolean",
            "default": true,
            "title": "Enable Safety Checker"
        },
        "image_size": {
            "description": "The size of the generated image.",
            "anyOf": [
                {
                    "x-webot-order-properties": [
                        "width",
                        "height"
                    ],
                    "type": "object",
                    "properties": {
                        "height": {
                            "maximum": 14142,
                            "description": "The height of the generated image.",
                            "type": "integer",
                            "default": 512,
                            "exclusiveMinimum": 0,
                            "title": "Height"
                        },
                        "width": {
                            "maximum": 14142,
                            "description": "The width of the generated image.",
                            "type": "integer",
                            "default": 512,
                            "exclusiveMinimum": 0,
                            "title": "Width"
                        }
                    },
                    "title": "ImageSize"
                },
                {
                    "enum": [
                        "square_hd",
                        "square",
                        "portrait_4_3",
                        "portrait_16_9",
                        "landscape_4_3",
                        "landscape_16_9"
                    ],
                    "type": "string"
                }
            ],
            "default": "square_hd",
            "title": "Image Size"
        },
        "control_scale": {
            "maximum": 1,
            "description": "The scale of the controlnet conditioning.",
            "type": "number",
            "minimum": 0,
            "default": 0.75,
            "title": "Control Scale"
        },
        "output_format": {
            "description": "The format of the generated image.",
            "enum": [
                "jpeg",
                "png",
                "webp"
            ],
            "type": "string",
            "default": "png",
            "title": "Output Format"
        },
        "num_images": {
            "maximum": 4,
            "description": "The number of images to generate.",
            "type": "integer",
            "minimum": 1,
            "default": 1,
            "title": "Number of Images"
        },
        "sync_mode": {
            "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
            "type": "boolean",
            "default": false,
            "title": "Sync Mode"
        },
        "control_start": {
            "maximum": 1,
            "description": "The start of the controlnet conditioning.",
            "type": "number",
            "minimum": 0,
            "default": 0,
            "title": "Control Start"
        },
        "image_url": {
            "description": "URL of Image for Inpaint generation.",
            "type": "string",
            "examples": [
                "https://storage.googleapis.com/falserverless/example_inputs/inpaint-input.jpg"
            ],
            "title": "Image URL"
        },
        "strength": {
            "maximum": 1,
            "description": "The strength of the inpaint conditioning.",
            "type": "number",
            "default": 1,
            "exclusiveMinimum": 0,
            "title": "Strength"
        },
        "acceleration": {
            "description": "The acceleration level to use.",
            "enum": [
                "none",
                "regular",
                "high"
            ],
            "type": "string",
            "default": "regular",
            "title": "Acceleration"
        },
        "seed": {
            "description": "\n            The same seed and the same prompt given to the same version of the model\n            will output the same image every time.\n        ",
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Seed"
        }
    },
    "type": "object",
    "required": [
        "prompt",
        "image_url",
        "mask_image_url"
    ],
    "title": "ZImageTurboInpaintInput"
}
Output (inside result.output) schema · fields, constraints and defaults
ParameterTypeRequiredDefault when omittedDescription / constraints
promptstringYes *No documented defaultThe prompt used for generating the image.
timingsobjectYes *No documented defaultThe timings of the generation process.
imagesarrayYes *No documented defaultThe generated image files info.
images[].content_typestring | nullNoNo documented defaultThe mime type of the file.
images[].urlstringYes *No documented defaultThe URL where the file can be downloaded from.
images[].file_sizeinteger | nullNoNo documented defaultThe size of the file in bytes.
images[].heightinteger | nullNoNo documented defaultThe height of the image
images[].file_namestring | nullNoNo documented defaultThe name of the file. It will be auto-generated if not provided.
images[].widthinteger | nullNoNo documented defaultThe width of the image
has_nsfw_conceptsarrayYes *No documented defaultWhether the generated images contain NSFW concepts.
seedintegerYes *No documented defaultSeed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.
{
    "x-webot-order-properties": [
        "images",
        "timings",
        "seed",
        "has_nsfw_concepts",
        "prompt"
    ],
    "properties": {
        "prompt": {
            "description": "The prompt used for generating the image.",
            "type": "string",
            "title": "Prompt"
        },
        "timings": {
            "description": "The timings of the generation process.",
            "additionalProperties": {
                "type": "number"
            },
            "type": "object",
            "title": "Timings"
        },
        "images": {
            "description": "The generated image files info.",
            "items": {
                "x-webot-order-properties": [
                    "url",
                    "content_type",
                    "file_name",
                    "file_size",
                    "width",
                    "height"
                ],
                "properties": {
                    "content_type": {
                        "description": "The mime type of the file.",
                        "anyOf": [
                            {
                                "type": "string"
                            },
                            {
                                "type": "null"
                            }
                        ],
                        "examples": [
                            "image/png"
                        ],
                        "title": "Content Type"
                    },
                    "url": {
                        "description": "The URL where the file can be downloaded from.",
                        "type": "string",
                        "title": "Url"
                    },
                    "file_size": {
                        "description": "The size of the file in bytes.",
                        "anyOf": [
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            }
                        ],
                        "examples": [
                            4404019
                        ],
                        "title": "File Size"
                    },
                    "height": {
                        "description": "The height of the image",
                        "anyOf": [
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            }
                        ],
                        "title": "Height"
                    },
                    "file_name": {
                        "description": "The name of the file. It will be auto-generated if not provided.",
                        "anyOf": [
                            {
                                "type": "string"
                            },
                            {
                                "type": "null"
                            }
                        ],
                        "examples": [
                            "z9RV14K95DvU.png"
                        ],
                        "title": "File Name"
                    },
                    "width": {
                        "description": "The width of the image",
                        "anyOf": [
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            }
                        ],
                        "title": "Width"
                    }
                },
                "type": "object",
                "required": [
                    "url"
                ],
                "title": "ImageFile"
            },
            "type": "array",
            "examples": [
                [
                    {
                        "url": "https://storage.googleapis.com/falserverless/example_outputs/z-image-inpaint-output.png",
                        "content_type": "image/png",
                        "height": 888,
                        "width": 512
                    }
                ]
            ],
            "title": "Images"
        },
        "has_nsfw_concepts": {
            "description": "Whether the generated images contain NSFW concepts.",
            "items": {
                "type": "boolean"
            },
            "type": "array",
            "title": "Has Nsfw Concepts"
        },
        "seed": {
            "description": "Seed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.",
            "type": "integer",
            "title": "Seed"
        }
    },
    "type": "object",
    "required": [
        "images",
        "timings",
        "seed",
        "has_nsfw_concepts",
        "prompt"
    ],
    "title": "ZImageTurboInpaintOutput"
}
Errors and limits

401 invalid/expired/revoked key · 403 key scope or domain mismatch · 404 unavailable model or unowned request · 409 quote changed, balance, concurrency or idempotency conflict · 413 JSON exceeds 2 MB · 415 wrong content type · 422 invalid fields/media · 429 rate limit · 503 temporary/ambiguous submission. Respect Retry-After. Current limits per account: 12 quotes/submissions, 120 result reads and 8 stream connections per minute. One submission preparation at a time per account. Do not automatically regenerate failed jobs.

Your requests

Alibaba Z-Image - Inpainting · Your account only

Select Requests to load your history.
Request IDCreated at (IST)StatusCredits usedRefundedProcessing timeReport
Your model analytics

Alibaba Z-Image - Inpainting · Request dates in IST

Select Analytics to load your metrics.

Total requests
—
Success rate
—
Credits used
—
Processing p50
—

Request counts

Daily requests by their current status

Request outcomes

Completed, failed and pending requests

Credits used

Daily recorded charges before refunds

Processing time

Daily average for completed requests with recorded timing

Processing percentiles

Completed requests only · Time from submission to recorded completion

How to use Alibaba Z-Image — Inpainting

Mark the part you want changed, where a mask is supported. The model fills or edits that area using the surrounding scene and your instructions.

Required inputs

  • Prompt: Your instructions to the model. Say what you want, include the important details and avoid contradictory directions. For a video, describe the action as well as the scene.
  • Image URL: The input picture. Use a clear image in one of the accepted formats. If the form offers upload, select a file there; if it asks for a URL, use an accessible HTTPS file link.
  • Mask Image URL: A selection map showing which area is affected. White may mean “change this area” or “keep this area” depending on the model. Follow this model’s documentation below; do not assume every mask works the same way.

Workflow

  1. Prepare your source material and fill the required inputs above. Review the supported settings for this model.
  2. Sign in to calculate the credit estimate. Review the estimate before choosing Generate.
  3. Keep this model page open while the request runs. Completed results arrive in the result area; use the available player or download controls to review the output.

When to use this workflow

  • Remove or replace an unwanted part.
  • Repair a selected area while guiding the edit.

Key settings

Prompt
Your instructions to the model. Say what you want, include the important details and avoid contradictory directions. For a video, describe the action as well as the scene.
Image URL
The input picture. Use a clear image in one of the accepted formats. If the form offers upload, select a file there; if it asks for a URL, use an accessible HTTPS file link.
Mask Image URL
A selection map showing which area is affected. White may mean “change this area” or “keep this area” depending on the model. Follow this model’s documentation below; do not assume every mask works the same way.
Image Size
The output dimensions, usually width and height in pixels or a named size. Pixels are tiny dots that form a picture. More pixels make a larger image; they do not automatically make it more accurate. Choose a size suited to where you will use it. Supported choices: "square_hd", "square", "portrait_4_3", "portrait_16_9", "landscape_4_3", "landscape_16_9"
Height
The vertical size: how tall the output is, usually in pixels. Width and height together determine the shape and total pixel count. Maximum: 14142. Greater than: 0
Width
The horizontal size: how wide the output is, usually in pixels. Changing it can also change the shape or crop. Respect the allowed increments as well as the minimum and maximum. Maximum: 14142. Greater than: 0

Related model workspaces

Product image workflow · Image input choices

Compare more AI models · Explore plans and credits