Branding

Manage logos and presets that keep customer-facing media on-brand.

Branding feature options

get

Returns the branding features that are unlocked for your account plus the endpoints you can call.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

Feature flags and available endpoints

application/json

401

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

application/json

get

/v1/branding/options

Inspect branding plan

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

{
  "plan": "text",
  "features": {
    "allowBranding": true
  },
  "endpoints": [
    {
      "method": "text",
      "path": "text"
    }
  ]
}

Upload branding logo and defaults

post

Store a logo and default placement options once so you can reuse them in watermark calls later.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

multipart/form-data

logostring · binaryRequired

Image file for your logo or stamp.

namestringOptional

Friendly name to help you pick the right preset later.

positionstring · enumOptional

Default placement on the image (south-east, north-west, centre, etc.).

Possible values:

opacitynumberOptional

Transparency level from 0 (invisible) to 1 (fully solid). Percentages like 0.6 are accepted.

scaleinteger · min: 1 · max: 100Optional

Default size as a percentage of the original logo.

Responses

200

Branding preset created

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

403

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

application/json

post

/v1/branding/upload

Save a branding preset

curl -X POST https://api.bridgeapi.store/v1/branding/upload \
  -H "X-API-Key: YOUR_KEY" \
  -F "logo=@/path/logo.png" \
  -F "name=Primary watermark" \
  -F "position=se" \
  -F "opacity=0.6" \
  -F "scale=40"

{
  "brandId": "text",
  "name": "text",
  "logo": {
    "url": "text",
    "contentType": "text",
    "sizeBytes": 1
  },
  "defaults": {
    "position": "text",
    "opacity": 1,
    "scale": 1
  }
}

List branding presets

get

Shows every stored branding preset so you can pick the right ID for watermarking.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

Presets list

application/json

401

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

application/json

get

/v1/branding/list

List presets

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

{
  "count": 1,
  "items": [
    {}
  ]
}

Get branding preset

get

Retrieve the stored logo and defaults so you can preview or audit them.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

Unique branding preset ID from the list endpoint.

Responses

200

Branding preset

application/json

Responseobject

401

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

application/json

404

The requested item does not exist or was deleted.

application/json

get

/v1/branding/{id}

Fetch one preset

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

{}

Delete branding preset

delete

Remove a branding preset you no longer need. Existing jobs using it will fall back to direct uploads.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

Branding preset ID to delete.

Responses

200

Deleted

application/json

401

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

application/json

404

The requested item does not exist or was deleted.

application/json

delete

/v1/branding/{id}

Delete preset

curl -X DELETE https://api.bridgeapi.store/v1/branding/brand_123 \
  -H "X-API-Key: YOUR_KEY"

{
  "ok": true
}