🧾 Request Parameters

Parameter	Type	Required	Description
`file`	`file`	✅ Yes (if `base64_str` is not provided)	The input image file to be processed (must be provided as a file, e.g., .jpg, .png).
`base64_str (≤ 1MB)`	`string`	✅ Yes (if `file` is not provided)	Base64-encoded string of the image file (used when sending image data directly in requests).
`prompt`	`object`	❌ No	A descriptive prompt (in English) to specify what objects or regions in the image to segment (e.g., "segment the cat"). If left empty, the API will apply the foreground-background segmentation result by default.
`return_mask`	`boolean`	✅ Yes	If set to true, the API will return the segmentation mask as an image. If false, only the segmented image is returned.
`score_threshold`	`float`	✅ Yes	Specifies the minimum confidence score required for a region or object to be included in the segmentation. Default value is 0.5.

✅ Successful Response Example

![image](https://aipix.net/static/examples/open-vocabulary-segmentation.webp)

![image](https://aipix.net/static/examples/open-vocabulary-segmentation2.webp)

![image](https://aipix.net/static/examples/open-vocabulary-segmentation3.webp)

📤 Response Example:

{
  "code": 200,
  "image": "data:image/webp;base64,...",
  "response_time": 0.656
}

❌ Error Responses

HTTP Code	JSON `code`	Description
422	422	Invalid input parameters.
429	429	Too many requests or timeout.
500	500	Internal server error.

📉 Error Response Format

{
  "code": <error_code>,
  "msg": "<brief error description>"
}

Example:

{
  "code": 429,
  "msg": "Too many requests."
}

📌 Notes

We strictly protect user privacy and do not store any user data.
We strive to minimize input restrictions (e.g., image size, text length), but excessive input volume may result in 429 or 500 errors.
The service operates at the maximum capacity of our servers, and we dynamically scale infrastructure to handle varying request loads.

📬 Support & Custom Deployment

For questions or support, please reach out to our team using the contact page.

We also offer dedicated server deployment for enterprise clients — a private, standalone environment that includes full API functionality with no request limits.

Pricing is based on the number of servers deployed, with each server serving at maximum throughput.

📩 Contact Us

📚 View Our API List