PDF password

Lock a document with an open password, or take one off when you know it.

curl -X POST "$DOATHING_API/v1/documents/pdf-encrypt" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"file": {"filename": "report.pdf", "content_type": "application/pdf", "data_b64": "<base64>"}, "password": "a-strong-passphrase"}'

Lock a document with an open password, or take one off when you know it.

Apply or remove PDF open-password encryption using AES-128 or AES-256.

Input

Send a file object with base64 data_b64, its content_type and a filename. Accepted types: application/pdf.

The declared type is not trusted — the bytes are sniffed and a contradiction is rejected rather than corrected.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "encrypted": true,
  "algorithm": "AES-256",
  "pages": 12,
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

3 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.

Parameters

Generated from the endpoint’s own validation, so this is exactly what it accepts. A body field goes at the top level; an option goes inside options.

Name	In	Type	Default	Notes
password *	body	string	—
owner_password	body	string	—
mode	options	string	"apply"	apply or remove. one of apply, remove
algorithm	options	string	"AES-256"	AES-256 or AES-128. one of AES-256, AES-128