Model API
Birefnet Background Removal
bilateral reference framework (BiRefNet) for high-resolution dichotomous image segmentation (DIS)
Model id
birefnetRun it
Quote the input, start the generation with the quote, then poll the job. Set RAYWAKE_API_KEY first; see Authentication.
# 1. Price the exact input (quotes are valid for up to 10 minutes)
curl -s https://api.raywake.com/v1/quotes \
-H "Authorization: Bearer $RAYWAKE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "birefnet",
"input": {
"image_url": "https://example.com/input.png"
}
}'
# 2. Start the generation with the quote_id from step 1
curl -s https://api.raywake.com/v1/generate \
-H "Authorization: Bearer $RAYWAKE_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"model": "birefnet", "quote_id": "QUOTE_ID", "input": {"image_url":"https://example.com/input.png"}}'
# 3. Poll until the status is terminal
curl -s https://api.raywake.com/v1/jobs/JOB_ID \
-H "Authorization: Bearer $RAYWAKE_API_KEY"Input
| Name | Type | Description |
|---|---|---|
model | string (enum) | Model to use for background removal. The 'General Use (Light)' model is the original model used in the BiRefNet repository. The 'General Use (Heavy)' model is a slower but more accurate model. The 'Portrait' model is a model trained specifically for portrait images. The 'General Use (Light)' model is recommended for most use cases. The corresponding models are as follows: - 'General Use (Light)': BiRefNet-DIS_ep580.pth - 'General Use (Heavy)': BiRefNet-massive-epoch_240.pth - 'Portrait': BiRefNet-portrait-TR_P3M_10k-epoch_120.pth |
operating_resolution | string (enum) | The resolution to operate on. The higher the resolution, the more accurate the output will be for high res input images. |
output_mask | boolean | Whether to output the mask used to remove the background |
refine_foreground | boolean | Whether to refine the foreground using the estimated mask |
sync_mode | boolean | If `True`, the media will be returned as a data URI and the output data won't be available in the request history. |
image_urlrequired | string (image URL) | URL of the image to remove background from |
output_format | string (enum) | The format of the output image |
Output
A succeeded job lists its results under outputs, stored on our side. See Jobs for every field.
"outputs": [
{ "type": "image", "url": "https://…", "mime_type": "image/png", "thumbnail_url": "https://…" }
]Pricing
- up to$0.28/ run
The exact charge for your input comes from a quote. How charges settle