API Reference
Console

Smart Crop

post
https://api.picsart.io/tools/1.0/smart-crop

Use AI to define the segment that should be cropped, e.g. foreground or product name (e.g. hat, gloves, boots, etc).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file

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

uri
length between 1 and 2083

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

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.)

string
required
length between 1 and 90

The segment to crop. Use either 'foreground', or define the name of the segments such as 'hat' or 'boots'. Recommendation: use short and clear names of the segment (e.g. object or area). We don't recommend using long prompts.

string
enum

Optionally enforce the ration of the result image. When both width and height parameters are provided, they should match this ratio. In case either width or height are provided, the other value will be calculated based on this ratio.

integer
≥ 0

Specify the width of the output image in pixels.

integer
≥ 0

Specify the height of the output image in pixels. The default is 1024 and the maximum acceptable value is 8000.

integer
0 to 100
Defaults to 0

The margin to add around the crop segment. Values are defined in pixels. When ratio is provided, that is applied after the margin is applied to guarantee the minimum gap before the edge of the image.

string
enum
Defaults to JPG

Optionally select one of the image formats. Options are as follows:

  • JPG
  • PNG
  • WEBP
Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago