Powered by Redocly

Deprecated Soon

Erase Elements

Description

The Remove Object Route is used to remove objects or areas.

This route will be deprecated soon and replaced soon with the '/eraser' endpoint, that doesn't require image registration.

You can provide the area for removal in the following methods:

  1. Call the /mask_generator endpoint, display the masks to the user, allow them to select a mask, and then send the mask_id to the objects/remove endpoint. Under the example named generated mask, you can see an example of this type of request.

  2. Allow the user to create a mask manually (by using a brush, for example), and then send the mask_url to the objects/remove endpoint. Under the example named manual mask, you can see an example of this type of request. You can access the SDK that demonstrates how to implement a brush feature in your Interface via the following link.

In one request, you may send multiple IDs of objects, or points, or masks for removal, but you cannot combine them in one request. For example, you cannot send a point and a mask_id at the same time.

You can also use this route on a modified image by providing the sid from the response of the previously used route.

This route returns both the URL and the sid associated with the updated image.

Request
path Parameters
visual_id
required
string

visual id of the image the user wants to remove objects from.

Example: 86f9986390596e8f
query Parameters
desired_resolution
string

The desired resolution of the updated image. This parameter is optional.

Enum: "original" "nhd" "svga" "xga" "had" "wuxga" "uwfhd" "wqxga" "uwqhd" "uhd"
Example: desired_resolution=original
original_quality
boolean

If you would like to retain the quality of the original image, please set this parameter to true. This parameter is optional. This parameter can also be used as a body parameter.

Example: original_quality=true
header Parameters
api_token
required
string
Request Body schema: application/json
sid
string

This session id was obtained from the response of a route that had been applied to this visual id. If you have used another route on the provided visual before, and you would like the current route to modify the result of that route, please provide this information. This parameter is optional.

enhance
boolean

Please use the value true in order to get the best result possible.

Array of objects

The requested changes to the image. In one request, you may send multiple IDs of objects, or points, or masks for removal, but you cannot combine them in one request. For example, you cannot send a point and a mask at the same time.

Responses
200

Successful operation.

400

Bad request.

404

Specified Image does not exist.

405

Method not allowed.

500

Internal server error.

506

Insufficient data. The given input is not supported by the Bria API.

post/{visual_id}/objects/remove
Request samples 
Response samples 
application/json
{}