Apply a decorative background preset.

Draws a built-in background (parchment, diploma, gradients, etc.) behind selected pages. Provide a PDF via `url` or upload. Drop this helper wherever you want to apply a decorative background preset with a single HTTP call. Send the documented inputs and the API streams back polished results you can hand directly to your users.

POST/documents/add-background

Parameters

Query Parameters

Name	Type	Description
url	string
background_id	string · required	Preset ID such as `parchment-classic`, `diploma-ivory`, `grid-tech`.
pages	string
dryrun	boolean

All helper calls accept your Dataczar key via the ak query parameter. Need one? Create or copy a key on Dataczar Connect and drop it into each request.

Responses

Status 200

PDF stream with the background applied.

Examples

Request

"POST /pdf/add-background?background_id=parchment-classic&dryrun=1"

Response

{
  "ok": true,
  "data": {
    "summary": [
      "Apply background 'parchment-classic'",
      "Pages: all"
    ]
  }
}

API keyBase URLMethod

File uploads (multipart form-data)

Attach PDFs or images as multipart fields. We'll fill in the field names for you.

Files

file

Query parameters

url optionalbackground_id requiredpages optionaldryrun optional

Equivalent curl

Grab your Dataczar API key

Every helper runs with the same simple API key. Sign in (or create a free Dataczar account) at Dataczar Connect to issue keys in seconds, then drop the key into any `ak=` parameter and start shipping.

Get your API key Browse helpers

Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.