mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-09-18 01:19:24 +00:00
1 line
90 KiB
JSON
1 line
90 KiB
JSON
|
{"openapi":"3.1.0","info":{"title":"Stirling PDF - Processing API","description":"API documentation for PDF processing operations including conversion, manipulation, security, and utility functions.","termsOfService":"https://www.stirlingpdf.com/terms","contact":{"name":"Stirling Software","url":"https://www.stirlingpdf.com","email":"contact@stirlingpdf.com"},"license":{"name":"MIT","url":"https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/refs/heads/main/LICENSE"},"version":"1.0.0"},"servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"tags":[{"name":"Filter","description":"Filter APIs"},{"name":"Security","description":"Security APIs"},{"name":"Pipeline","description":"Pipeline APIs"},{"name":"Proprietary UI Data","description":"APIs for React UI data (Proprietary features)"},{"name":"Analysis","description":"Analysis APIs"},{"name":"Misc","description":"Miscellaneous PDF APIs"},{"name":"Misc","description":"Miscellaneous APIs"},{"name":"Convert","description":"Convert APIs"},{"name":"General","description":"General APIs"}],"paths":{"/api/v1/security/validate-signature":{"post":{"tags":["Security"],"summary":"Validate PDF Digital Signature","description":"Validates the digital signatures in a PDF file against default or custom certificates. Input:PDF Output:JSON Type:SISO","operationId":"validateSignature","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SignatureValidationRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SignatureValidationResult"}}}}}}}},"/api/v1/security/sanitize-pdf":{"post":{"tags":["Security"],"summary":"Sanitize a PDF file","description":"This endpoint processes a PDF file and removes specific elements based on the provided options. Input:PDF Output:PDF Type:SISO","operationId":"sanitizePDF","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SanitizePdfRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}}}},"/api/v1/security/remove-password":{"post":{"tags":["Security"],"summary":"Remove password from a PDF file","description":"This endpoint removes the password from a protected PDF file. Users need to provide the existing password. Input:PDF Output:PDF Type:SISO","operationId":"removePassword","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PDFPasswordRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}}}},"/api/v1/security/remove-cert-sign":{"post":{"tags":["Security"],"summary":"Remove digital signature from PDF","description":"This endpoint accepts a PDF file and returns the PDF file without the digital signature. Input:PDF, Output:PDF Type:SISO","operationId":"removeCertSignPDF","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PDFFile"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}}}},"/api/v1/security/redact":{"post":{"tags":["Security"],"summary":"Redacts areas and pages in a PDF document","description":"This operation takes an input PDF file with a list of areas, page number(s)/range(s)/function(s) to redact. Input:PDF, Output:PDF, Type:SISO","operationId":"redactPDF","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ManualRedactPdfRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}}}},"/api/v1/security/get-info-on-pdf":{"post":{"tags":["Security"],"summary":"Summary here","description":"desc. Input:PDF Output:JSON Type:SISO","operationId":"getPdfInfo","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PDFFile"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}}}},"/api/v1/security/cert-sign":{"post":{"tags":["Security"],"summary":"Sign PDF
|