Deploy your own API

nobg is a background removal API you deploy to Cloudflare Workers. Your backend uploads an image, and the Worker returns a transparent PNG or WebP using Cloudflare Images.

Follow the deployment guide to install the project, configure your Worker, and publish the API.

What you need

• Access to the nobg repository, Node.js, and pnpm.
• A Cloudflare account with permission to deploy Workers.
• Cloudflare Images access for background removal. Check requirements and costs before enabling it.

What gets deployed

You deploy one Hono Worker from apps/api. It has an Images binding and SQLite-backed Durable Objects for IP quotas and a shared monthly budget. Wrangler creates the quota storage on deployment. No upload bucket is needed.

The API runs independently of this documentation site. You do not need to build or host the website to use it. All deployment commands in these guides target @nobg/api explicitly.

After deployment

• Call the API from curl, JavaScript, or Python.
• Configure your Worker to adjust limits or add a domain.
• Operate the service to inspect logs, adjust quotas, and deploy updates.
• Troubleshoot errors using the response code and request ID.

Processing and validation

You control the Worker and its usage limits. Cloudflare’s managed Images service processes the image bytes and bills your account for usage. nobg does not store uploads or results.

The API has been tested locally with mocked Images responses. Background removal against the paid service has not been validated for this release. The deployment guide separates checks that do not call Images from an optional image-processing request.