Remove Background
POST/api/v1/background/remove/generate
Remove the background from an image. The endpoint costs 5 credits per image. See Pricing for the latest rates. Task businessType is REMOVE_BACKGROUND when polling /api/v1/tasks/{businessType}/{taskId}.
Request
Responses
- 200
- 400
- 401
- 429
- 500
- 503
Task accepted.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
The request is invalid, the account is not subscribed, or the account has insufficient credits.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
The x-api-key header is missing, invalid, or inactive.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
A per-key or service-wide call-rate limit was exceeded. Retry according to the response headers.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
Limit for the scope that rejected the request.
Remaining capacity for the rejecting scope; normally 0 on a 429 response.
Unix timestamp in seconds when the rejecting scope is expected to reset.
Minimum number of seconds to wait before retrying.
Rejecting scope: api_key_minute, api_key_hour, global_minute, global_hour, or api_key_active_tasks.
An unexpected server-side error occurred.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
A protective service or dependency is temporarily unavailable. Retry with backoff.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
Minimum number of seconds to wait before retrying.