Inpaint Image

post

https://genai-api.picsart.io/v1/painting/inpaint

The Inpainting service offers inpainting (image2Image) capabilities, enabling users to fill or replace areas within an image based on specified criteria. It operates in two modes: Single Image Mode: Submit one RGBA image. The API fills the specified inner area with content based on the prompt parameter. Mask Mode: Along with the RGBA image, provide a mask of identical size and format. The API uses this mask to identify areas for inpainting with content determined by the prompt parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This is an asynchronous process. Use the provided transaction identifier to pull the result with Get the Inpaint result.

Body Params

image

file

Source image file (binary). (If this parameter is present, the other image source parameters must be empty.)

image_url

uri

length between 1 and 2083

Source image URL. (If this parameter is present, the other image source parameters must be empty.)

image_id

string

deprecated

Deprecated. Source image ID of an image previously uploaded to Picsart or result image ID from a different API. (If this parameter is present, the other image source parameters must be empty.)

mask_image

file

Source mask file (binary). (If this parameter is present, the other mask source parameters must be empty.)

mask_image_url

uri

length between 1 and 2083

Source mask URL. (If this parameter is present, the other mask source parameters must be empty.)

mask_image_id

string

deprecated

Deprecated. Source mask ID of an mask previously uploaded to Picsart or result mask ID from a different API. (If this parameter is present, the other mask source parameters must be empty.)

prompt

string

required

The prompt.

negative_prompt

string

deprecated

Deprecated. The negative prompt (don’t generate this type of images). Don't use the nagitve keywords such as 'no', e.g. don't use 'no distorted faces', use 'distorted faces'.

count

integer

1 to 10

Defaults to 2

The number of images to generate.

format

string

enum

Defaults to JPG

Optionally select one of the image formats (JPG is default). Options are as follows:

JPG
PNG
WEBP

Allowed:

mode

string

enum

Defaults to sync

deprecated

Deprecated. The mode parameter is now deprecated. To control synchronous vs asynchronous execution, use the standard HTTP Prefer header (RFC 7240). If both mode and Prefer are provided, Prefer takes precedence. For migration guidance and examples, see the Sync and Async Execution guide.
Use this query parameter to establish the processing mode. Acceptable values are sync, async and auto (sync is default):

sync: issues a synchronous request, response is given when the result is ready.
async: forces an asynchronous request, the response, which is instantaneous, contains a "transaction_id" which is used to poll for the result.
REMOVED - auto: the processing mode decision is made by the service, which depends upon the expected processing time.

Allowed:

Responses

200Success.

202Processing.

400Bad Request

401Unauthorized

402Payment Required

403Forbidden

404Not Found

405Method Not Allowed

413Request Entity Too Large

415Unsupported Media Type

429Too Many Requests

431Request Header Fields Too Large

500Internal Server Error

503Service Unavailable