Skip to main content
POST
Add PDF Password and Security

Request contract

  • Method and path: POST /apis/v1/pdf-co/pdf-security-add
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/pdf-co/pdf-security-add
  • Runtime facts: 2a3bd567205aeb00d10d4a6e8fbb280d098e3912e71bc16c07b9f91f82195a26
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

Usage-based billing; Default request estimate: $0.0103 USD (not a fixed price). Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.0103
  • Declared unit rate (USD): 1e-06
  • Billing unit: provider_credit
  • Cost contract: response_units
  • Published reference multiplier: 1.0
  • Declared maximum count/units: 10000000
  • Settlement evidence source: response_body

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

URL of the source PDF file to secure.

name
string

File name for the generated PDF.

profiles
object

Advanced PDF.co profile settings.

expiration
integer

Number of minutes before the temporary output link expires.

printQuality
enum<string>

Printing quality allowed for the secured PDF.

Available options:
LowResolution,
HighResolution
userPassword
string

Password required to view or print the PDF; this password alone cannot change document restrictions.

ownerPassword
string

Owner password used to encrypt the PDF and change document restrictions; it is required when modifying any allow* restriction.

allowFillForms
boolean

Whether to allow filling interactive form and signature fields; ownerPassword is required to modify this restriction.

allowPrintDocument
boolean

Whether to allow printing; ownerPassword is required to modify this restriction.

allowModifyDocument
boolean

Whether to allow document modification; ownerPassword is required to modify this restriction.

encryptionAlgorithm
enum<string>

Encryption algorithm for the secured PDF.

Available options:
RC4_40bit,
RC4_128bit,
AES_128bit,
AES_256bit
allowAssemblyDocument
boolean

Whether to allow document assembly; ownerPassword is required to modify this restriction.

allowContentExtraction
boolean

Whether to allow copying PDF content; ownerPassword is required to modify this restriction.

allowModifyAnnotations
boolean

Whether to allow interaction with annotations and forms; ownerPassword is required to modify this restriction.

allowAccessibilitySupport
boolean

Whether to allow content extraction for accessibility; ownerPassword is required to modify this restriction.

Response

Tool result data

error
boolean
required
status
required
url
string
name
string
credits
integer
duration
integer
pageCount
integer
remainingCredits
integer