Inpaint

Inpaint image

Changed on Sep 1, 2026

Creates a pixel art image based on the provided parameters. Called "Inpaint" in the plugin.

Supported image size:

Maximum area 200x200

Supported features:

Inpainting
Init image
Forced palette
Transparent background

Using the Python client:

import pixellab

client = pixellab.Client(secret="YOUR_API_TOKEN")

response = client.inpaint(
    description="boy with wings",
    image_size=dict(width=16, height=16),
    inpainting_image=image_of_boy_without_wings,
    mask_image=mask_image,
)
response.image.pil_image()

post/inpaint

Request

Base URL
https://api.pixellab.ai/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/pixellab/apis/pixel-lab-api/docs/inpaint/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

descriptionstring required

Text description of the image to generate

negative_descriptionstring

Text description of what to avoid in the generated image

text_guidance_scalenumber

How closely to follow the text description

extra_guidance_scalenumber

(Deprecated)

outline'single color black outline' | 'single color outline' | 'selective outline' | 'lineless'

shading'flat shading' | 'basic shading' | 'medium shading' | 'detailed shading' | 'highly detailed shading'

detail'low detail' | 'medium detail' | 'highly detailed'

view'side' | 'low top-down' | 'high top-down'

isometricboolean

Generate in isometric view

oblique_projectionboolean

Generate in oblique projection

no_backgroundboolean

Generate with transparent background

init_image_strengthinteger

Strength of the initial image influence

seedinteger nullable

Seed decides the starting noise

Example request

{
  "description": "cute dragon",
  "image_size": {
    "height": 128,
    "width": 128
  },
  "no_background": true
}

Response

Successfully generated image

Changes

Sep 1, 2026eb7a18b195ba Revision changes
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  the request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the response property / became optional for the status
- breaking
  response property usage/usd list-of-types was widened by adding types null to media type application/json of response 200
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  added the new generations enum value to the / response property for the response status
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  added the optional property / to the response with the status
- info
  the response property const value base64 was added for the status
- info
  removed the base64 enum value from the / response property for the response status

Operation history