Edit Image with a Prompt
Edit any image with a prompt. Apply any transformation, any type of detail you can imaging and the AI will apply it to the image. Choose from the big range of models if you have preferences or to take control of the output quality.
Request
- Base URLhttps://genai-api.picsart.io/v1
- URLhttps://genai-api.picsart.io/v1/painting/edit
- AuthAPI key in header X-Picsart-API-Key
Request body multipart/form-data
Source image file (binary). (If this parameter is present, the other image source parameters must be empty.)
Source image URL. (If this parameter is present, the other image source parameters must be empty.)
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.)
The prompt.
Desired output width. When unset, derived from the input image dimensions.
Desired output height. When unset, derived from the input image dimensions.
The number of images to generate.
Optionally select one of the image formats (JPG is default). Options are as follows:
- JPG
- PNG
- WEBP
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.
Enables the watermark. This is primarily used to show that the image is AI-generated, but this can be used for other use cases as well. When enabled, the default watermark will be added. When customization is needed, follow other "watermark**" parameters. For more advanced watermarking, you can also check out the Add Watermark service.
URL of the watermark image. If omitted or empty and watermark_enabled is true, a default watermark is applied.
Define the opacity of the watermark. Takes values from 0 to 100. Default is 100 (opaque). Set to 0 to make it transparent.
Define the angle of the watermark. Takes values from 0 to 360. Default 45 for pattern case, otherwise 0.
Optionally choose a specific AI model to use for this request. If not specified, a default model will be applied. Please note that the default model may change over time as Picsart continues to improve performance and accuracy. Any change to the default will be made only after thorough testing and validation to ensure it delivers better results. If you require consistent behavior or wish to evaluate different models on your own, we recommend explicitly setting this parameter.
Example request
{
"count": 2
}Response
Success.
Changes
No recorded changes to this operation across all 1 revision of this API.