Settings

Get device settings

Returns the device's current conversion settings. For settings that are not present, default values are returned.

get/settings

Request

  • Base URL: https://pdf2md.dev
  • URL: https://pdf2md.dev/settings
  • Auth: HTTP bearer

Headers

X-Timestampinteger required
Example:1700000000

Unix time (sec) for the request signature (±300s window, see docs/security.md)

X-Noncestring required
Example:bXlfbm9uY2UtdjE

Random string (base64url), unique per request (TTL 5 minutes, anti-replay)

X-Body-SHA256string required
Example:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

hex sha256 of the request body (for GET/DELETE — sha256 of an empty body)

X-Signaturestring required
Example:MEYCIQCZqlk3E1p5k2y1hZ0ykjW9tzjO4GDBWJ3QYw9UWF2gtwIhAKuQKk8NfZp7uA9u6YzKxHnD7bHkHHRp2tkMZ0QYpQMb

Signature of the canonical string (ES256), see docs/security.md

Response

Device settings

image_mode'embedded' | 'placeholder' required

Image handling mode in Markdown

ocr_enabledboolean required

Enable OCR for text recognition on scans

engine'docling' | 'mineru'

Conversion engine (EP-015). Both engine containers are running; at most one is resident (single-resident, EP-016). The old extension does not send this field → the backend uses the default. EP-016: default mineru (reliable on scans/Cyrillic); changed via env DEFAULT_ENGINE. docling — optional for simple PDFs.

conversion_mode'simple' | 'auto' | 'full'

Conversion mode / fast-path (EP-014). simple — the lightweight docling pipeline, auto — autodetect + fallback to full, full — the full pipeline. Backward compatibility: when the field is absent the backend uses full (behavior identical to before). The new extension's UI defaults to auto.

Changes

No recorded changes to this operation across all 1 revision of this API.