API Endpoints

/generate/segment

post
https://api.cloud.scenario.com/v1/generate/segment

Trigger the segmentation of an image. The process will create a new Asset with the segmentation mask as a child.

Query Params
string

If set to true, returns the original asset without transformation

string
Body Params
string
enum
Defaults to fastsam_x

The checkpoint to use

Allowed:
string
required

The input image to process. Must reference an existing AssetId or be a data URL.

boolean
Defaults to false

Boolean to output the contours.

number
0 to 30

The number of pixels to dilate the result masks.

bbox
array

A bounding box around the object of interest, in the format [x1, y1, x2, y2].

bbox
number
0 to 255

Int to set between 0 and 255 for the opacity of the background in the result images.

boolean
Defaults to false

Remove small dark spots (i.e. “pepper”) and connect small bright cracks.

string
length ≤ 100

A textual description / keywords describing the object of interest.

boolean
Defaults to false

Boolean to able output the cut out object.

points
array of arrays

List of points (label, x, y) in the image where label = 0 for background and 1 for object.

points
boolean
Defaults to true

Boolean to able return the masks (binary image) in the response.

Responses

Updated 6 months 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 6 months ago