Dataczar
Browse helpers

API Reference / documents / add-background

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.

GETPOST/documents/add-background

Where this helper shines

Apply a decorative background preset. keeps documents helpers on autopilot. Use it whenever you need to apply a decorative background preset without pausing a sprint or asking design/dev to jump in.

  • Trigger this helper whenever you need to apply a decorative background preset without waiting on a full deploy.
  • Drop it into automations (Zapier, Make, workers) to apply a decorative background preset as part of your workflow.
  • Share the GET URL so support and success can apply a decorative background preset safely using their Dataczar API key.

Copy & ship snippets

GET

Instant link

GET https://api.dataczar.app/documents/add-background?url=https%3A%2F%2Fexample.com%2Fsample.png&background_id=sample-background_id&pages=all&dryrun=true&ak=demo

Open directly in any browser, webhook, or low-code workflow.

curl

curl GET

curl "https://api.dataczar.app/documents/add-background?url=https%3A%2F%2Fexample.com%2Fsample.png&background_id=sample-background_id&pages=all&dryrun=true&ak=demo"

Swap ak=demo with your Dataczar API key.

curl

curl POST

curl -X POST "https://api.dataczar.app/documents/add-background?ak=demo" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/sample.png",
  "background_id": "sample_background_id",
  "pages": "sample_pages",
  "dryrun": true
}'

Send JSON payloads from back-end jobs, queues, or workers.

Parameters

Query Parameters

NameTypeDescription
urlstring
background_idstring · requiredPreset ID such as `parchment-classic`, `diploma-ivory`, `grid-tech`.
pagesstring
dryrunboolean

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"
    ]
  }
}

File uploads (multipart form-data)

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

Files
file — PDF document

Query parameters

Body parameters

We'll send these as JSON for POST/PUT/PATCH requests and as query params for GET.

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 keyBrowse helpers
Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.