POST
javascript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const axios = require('axios');
const fs = require('fs');
const path = require('path');
async function toB64(imgPath) {
const data = fs.readFileSync(path.resolve(imgPath));
return Buffer.from(data).toString('base64');
}
const api_key = "YOUR API-KEY";
const url = "https://api.segmind.com/v1/utility-image-mask";
const data = {
"image": "toB64('undefined')"
};
(async function() {
try {
const response = await axios.post(url, data, { headers: { 'x-api-key': api_key } });
console.log(response.data);
} catch (error) {
console.error('Error:', error.response.data);
}
})();RESPONSE
image/jpeg
HTTP Response Codes
200 - OKImage Generated
401 - UnauthorizedUser authentication failed
404 - Not FoundThe requested URL does not exist
405 - Method Not AllowedThe requested HTTP method is not allowed
406 - Not AcceptableNot enough credits
500 - Server ErrorServer had some issue with processing
Attributes
imageimage ( default: 1 )
Optional source image (used to derive size if width/height missing)
widthint ( default: 1 )
Mask canvas width (required if image not provided)
heightint ( default: 1 )
Mask canvas height (required if image not provided)
operationsstr *
Mask ops. Primary: {"op":"from_json","bboxes":[{"bbox":[x1,y1,x2,y2]}],"coord_format":"absolute_pixels","shape_type":"rect"}
return_previewbool ( default: 1 )
If true and image provided, also return RGBA preview overlay.
formatenum:str ( default: png )
Output format
Allowed values:
To keep track of your credit usage, you can inspect the response headers of each API call. The x-remaining-credits property will indicate the number of remaining credits in your account. Ensure you monitor this value to avoid any disruptions in your API usage.
Image Mask — utility-tools canary slug.
Popular Models
