Image Processing

Transform, resize, or annotate images with simple HTTPS requests.

Remove background (JSON or PNG)

post

Remove the background from a single image. By default the endpoint returns a JSON description from the upstream background-removal worker. To receive raw PNG bytes, set raw=true (query or form field) or set Accept: image/png.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

The source image.

rawbooleanOptional

When true, return PNG bytes instead of JSON.

modelstringOptional

Optional model hint for the upstream worker.

alphaMattebooleanOptional

Return alpha matte if supported by the model.

Responses

200

JSON envelope by default or PNG bytes when raw=true.

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

501

The feature is turned off on this deployment. Contact support if you expected it to work.

application/json

post

/v1/transparent

curl -X POST https://api.bridgeapi.store/v1/transparent \\
  -H "X-API-Key: YOUR_KEY" \\
  -F "file=@/path/to/photo.jpg" \\
  -F "raw=false"

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Remove background (PNG bytes)

post

Always returns PNG bytes with the background removed.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

The source image.

modelstringOptional

Optional model hint for the upstream worker.

alphaMattebooleanOptional

Return alpha matte if supported by the model.

Responses

200

PNG image bytes with background removed.

image/png

Responsestring · binary

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

501

The feature is turned off on this deployment. Contact support if you expected it to work.

application/json

post

/v1/transparent/png

Return PNG bytes

curl -X POST https://api.bridgeapi.store/v1/transparent/png \\
  -H "X-API-Key: YOUR_KEY" \\
  -F "file=@/path/to/photo.jpg" \\
  --output cutout.png

binary

Convert image

post

Upload a single image and BridgeAPI will change it to the format you need. This is handy when a website only accepts JPEG but you currently have a PNG, or when you want to shrink a photo before placing it in a slide deck. You must include your image file and can optionally control the output format and quality.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

The source image you want to convert.

formatstring · enumOptional

Choose the desired output format. Leave blank to keep the original format.

Possible values:

qualityinteger · min: 1 · max: 100Optional

Optional compression quality (higher means better quality but larger files).

Responses

200

Binary image data in the chosen format.

Responsestring · binary

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/convert

Convert PNG to JPEG

curl -X POST https://api.bridgeapi.store/v1/image/convert \
  -H "X-API-Key: YOUR_KEY" \
  -F "file=@/path/to/input.png" \
  -F "format=jpeg" \
  --output converted.jpeg

binary

Convert image to target size

post

Compress an image until it lands near a size that you choose. This is perfect for upload forms that only allow files under a certain number of kilobytes. BridgeAPI will try different quality levels automatically while preserving as much visual clarity as possible.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

The original image file you would like to shrink.

formatstringOptional

Desired output format. Leave blank to keep original format.

targetKBintegerOptional

Aim for this many kilobytes (KB). BridgeAPI stops when it gets as close as possible.

targetMBintegerOptional

Alternative target in megabytes (MB). Use either targetKB or targetMB.

tolerancePctinteger · min: 1 · max: 30Optional

How far above the target size is acceptable. A tolerance of 10 means ±10%.

Responses

200

Binary image data that lands close to the requested target size.

Responsestring · binary

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

422

BridgeAPI tried to fulfil the request but could not reach the target goal (for example, compression target).

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/convert/target

Fit under 200 KB

curl -X POST https://api.bridgeapi.store/v1/image/convert/target \
  -H "X-API-Key: YOUR_KEY" \
  -F "file=@/path/to/highres.jpg" \
  -F "targetKB=200" \
  -F "tolerancePct=8" \
  --output compressed.jpg

binary

Text overlay

post

Place a text caption on top of an image. Use this when you want to watermark social-media posts, add a label or version number, or write a short note on screenshots before sharing them.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

The base image you want to label.

textstringOptional

The words that should appear on the image.

Responses

200

Image with the added text overlay.

Responsestring · binary

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/text

Add caption to photo

curl -X POST https://api.bridgeapi.store/v1/image/text \
  -H "X-API-Key: YOUR_KEY" \
  -F "file=@/path/to/photo.jpg" \
  -F "text=Draft v2" \
  --output captioned.jpg

binary

Watermark overlay

post

Stamp a watermark image onto another image so that screenshots or documents keep your branding. Supply either a watermark file directly or reference a stored branding preset.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

Base image to watermark.

markstring · binaryOptional

Optional watermark graphic. Provide this or brandId.

brandIdstringOptional

Use an existing branding preset instead of uploading mark each time.

Responses

200

Image with the watermark applied.

Responsestring · binary

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

403

The request was understood but cannot be performed for this account or plan.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/watermark

Watermark with saved preset

curl -X POST https://api.bridgeapi.store/v1/image/watermark \
  -H "X-API-Key: YOUR_KEY" \
  -F "file=@/path/to/render.png" \
  -F "brandId=brand_123" \
  --output branded.png

binary

Batch convert images

post

Convert many images in one call. Send multiple files and BridgeAPI will process them sequentially so you can download them as a zip or JSON envelope. Ideal for preparing product photos or marketing assets at once.

Authorizations

X-API-KeystringRequired

Body

file[]string · binary[]Optional

Each image you want to convert.

formatsstringOptional

Comma-separated list of desired output formats. If fewer formats than files are provided, the last one is reused.

Example: jpeg,png

Responses

200

Zip archive containing converted images or JSON with Base64 content when requested.

Responsestring · binary

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/convert/batch

Convert multiple images

curl -X POST https://api.bridgeapi.store/v1/image/convert/batch \
  -H "X-API-Key: YOUR_KEY" \
  -F "file[]=@/path/front.png" \
  -F "file[]=@/path/back.png" \
  -F "formats=webp" \
  --output converted.zip

binary

Strip image metadata

post

Remove EXIF and other metadata from an image. Optionally re-encode to a target format.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

Source image.

formatstring · enumOptionalPossible values:

Responses

200

Binary image with metadata removed, or JSON when requested.

string · binaryOptional

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/strip-metadata

POST /v1/image/strip-metadata HTTP/1.1
Host: api.bridgeapi.store/
X-API-Key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 33

{
  "file": "binary",
  "format": "jpeg"
}

binary

Extract image metadata

post

Return EXIF and decoder metadata as JSON.

Authorizations

X-API-KeystringRequired

Body

filestring · binaryOptional

Source image.

Responses

200

JSON with metadata fields.

application/json

400

The input had a mistake. Fix the parameters or body and try again.

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

500

BridgeAPI encountered an internal problem. Retry later or contact support with the requestId.

application/json

post

/v1/image/metadata

POST /v1/image/metadata HTTP/1.1
Host: api.bridgeapi.store/
X-API-Key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Image options and limits

get

Learn the current plan limits for image endpoints, including max file sizes, supported formats, and quotas.

Authorizations

X-API-KeystringRequired

Responses

200

Plan-based limits, supported formats, and parameter ranges

application/json

401

Missing or incorrect X-API-Key. BridgeAPI cannot process anonymous calls.

application/json

get

/v1/image/options

Check image plan limits

curl -X GET https://api.bridgeapi.store/v1/image/options \
  -H "X-API-Key: YOUR_KEY"

{
  "plan": "text",
  "user": {
    "id": "text",
    "planId": "text",
    "quotaLeft": 1,
    "maxFileMB": 1,
    "monthlyLimit": 1
  },
  "limits": {
    "maxFileMB": 1,
    "monthlyLimit": 1,
    "quotaLeft": 1,
    "burstPerMinute": 1
  },
  "formats": {
    "input": [
      "text"
    ],
    "output": [
      "text"
    ]
  },
  "params": {},
  "responses": {}
}

NextPDF Tools

Last updated 6 months ago

hashtagRemove background (JSON or PNG)

hashtagRemove background (PNG bytes)

hashtagConvert image

hashtagConvert image to target size

hashtagText overlay

hashtagWatermark overlay

hashtagBatch convert images

hashtagStrip image metadata

hashtagExtract image metadata

hashtagImage options and limits

Remove background (JSON or PNG)

Remove background (PNG bytes)

Convert image

Convert image to target size

Text overlay

Watermark overlay

Batch convert images

Strip image metadata

Extract image metadata

Image options and limits