Apply a named PDF recipe.

Recipes are friendly presets that wrap the composite pipeline (e.g., `parchment-confidential`, `diploma`, `top-secret-dossier`, `paid-invoice`, `eyes-only`). Optional `overrides` or `extra_steps` arrays can tweak the defaults.

GETPOST/documents/recipes/{recipe_id}

Where this helper shines

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

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

Copy & ship snippets

GET

Instant link

GET https://api.dataczar.app/documents/recipes/{recipe_id}?url=https%3A%2F%2Fexample.com%2Fsample.png&dryrun=true&ak=demo

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

curl

curl GET

curl "https://api.dataczar.app/documents/recipes/{recipe_id}?url=https%3A%2F%2Fexample.com%2Fsample.png&dryrun=true&ak=demo"

Swap ak=demo with your Dataczar API key.

curl

curl POST

curl -X POST "https://api.dataczar.app/documents/recipes/{recipe_id}?ak=demo" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/sample.png",
  "overrides": "sample_overrides",
  "extra_steps": "sample_extra_steps",
  "dryrun": true
}'

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

Parameters

Query Parameters

Name	Type	Description
url	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 styled according to the recipe.

Examples

Request

"POST /pdf/recipes/parchment-confidential?dryrun=1"

Response

{
  "ok": true,
  "data": {
    "summary": [
      "Recipe 'parchment-confidential'",
      "2 total steps"
    ]
  }
}

API key

HTTP method

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

Path parameters

recipe_id

Query parameters

url optionaldryrun optional

Body parameters

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