{"openapi":"3.0.3","info":{"title":"BoxPDF API","version":"2.31.4","description":"REST API for converting uploaded PDF documents into scanned-style PDF, JPEG, PNG, or image-based DOCX output."},"servers":[{"url":"https:\/\/boxpdf.ir\/wp-json\/pdf-scan-maker\/v1"}],"paths":{"\/capabilities":{"get":{"summary":"Get server conversion capabilities","security":[{"BearerAuth":[]},{"ApiKeyHeader":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Capability report with the authenticated token plan, validity and remaining quotas.","headers":{"X-PSM-Key-Daily-Limit":{"description":"Daily token quota, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Daily-Remaining":{"description":"Daily token quota remaining after this request, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Monthly-Limit":{"description":"Monthly token quota, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Monthly-Remaining":{"description":"Monthly token quota remaining after this request, or unlimited.","schema":{"type":"string"}},"X-BoxPDF-Plan":{"description":"Commercial plan title assigned to this token.","schema":{"type":"string"}},"X-BoxPDF-Token-Type":{"description":"Token consumer type: api or plugin.","schema":{"type":"string","enum":["api","plugin"]}},"X-BoxPDF-Days-Remaining":{"description":"Whole validity days remaining, or unlimited.","schema":{"type":"string"}},"X-BoxPDF-Expires-At":{"description":"Token expiry timestamp in ISO-8601, or unlimited.","schema":{"type":"string"}}},"content":{"application\/json":{"schema":{"type":"object","properties":{"token_usage":{"$ref":"#\/components\/schemas\/TokenUsage"}}}}}},"401":{"description":"Unauthorized or expired token"}}}},"\/convert":{"post":{"summary":"Convert a PDF document","security":[{"BearerAuth":[]},{"ApiKeyHeader":[]},{"BasicAuth":[]}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"},"output":{"type":"string","enum":["pdf","jpeg","png","docx","word"],"default":"pdf","description":"word is accepted as an alias of docx."},"dpi":{"type":"integer","enum":[96,120,150,200,300],"default":150},"color":{"type":"string","enum":["color","grayscale","bw"],"default":"grayscale"},"preset":{"type":"string","enum":["clean","office","photocopy","archive"],"default":"office"},"pages":{"type":"string","example":"1-3,5,8"},"quality":{"type":"integer","minimum":55,"maximum":98,"default":86},"skew":{"type":"number","minimum":0,"maximum":1.2,"default":0.25},"noise":{"type":"integer","minimum":0,"maximum":18,"default":3},"contrast":{"type":"integer","minimum":80,"maximum":150,"default":108},"brightness":{"type":"integer","minimum":85,"maximum":120,"default":102},"threshold":{"type":"integer","minimum":110,"maximum":230,"default":178},"lines_enabled":{"type":"boolean","default":true},"line_style":{"type":"string","enum":["mixed","scanner","printer"],"default":"mixed"},"lines":{"type":"integer","minimum":0,"maximum":100,"default":18}}}}}},"responses":{"201":{"description":"Conversion completed; returns a temporary one-time download URL and token usage snapshot.","headers":{"X-PSM-Key-Daily-Limit":{"description":"Daily token quota, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Daily-Remaining":{"description":"Daily token quota remaining after this request, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Monthly-Limit":{"description":"Monthly token quota, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Monthly-Remaining":{"description":"Monthly token quota remaining after this request, or unlimited.","schema":{"type":"string"}},"X-BoxPDF-Plan":{"description":"Commercial plan title assigned to this token.","schema":{"type":"string"}},"X-BoxPDF-Token-Type":{"description":"Token consumer type: api or plugin.","schema":{"type":"string","enum":["api","plugin"]}},"X-BoxPDF-Days-Remaining":{"description":"Whole validity days remaining, or unlimited.","schema":{"type":"string"}},"X-BoxPDF-Expires-At":{"description":"Token expiry timestamp in ISO-8601, or unlimited.","schema":{"type":"string"}}},"content":{"application\/json":{"schema":{"type":"object","properties":{"token_usage":{"$ref":"#\/components\/schemas\/TokenUsage"}}}}}},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized"},"413":{"description":"File or page limit exceeded"},"429":{"description":"Per-minute, daily or monthly conversion quota exceeded","headers":{"X-PSM-Key-Daily-Limit":{"description":"Daily token quota, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Daily-Remaining":{"description":"Daily token quota remaining after this request, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Monthly-Limit":{"description":"Monthly token quota, or unlimited.","schema":{"type":"string"}},"X-PSM-Key-Monthly-Remaining":{"description":"Monthly token quota remaining after this request, or unlimited.","schema":{"type":"string"}},"X-BoxPDF-Plan":{"description":"Commercial plan title assigned to this token.","schema":{"type":"string"}},"X-BoxPDF-Token-Type":{"description":"Token consumer type: api or plugin.","schema":{"type":"string","enum":["api","plugin"]}},"X-BoxPDF-Days-Remaining":{"description":"Whole validity days remaining, or unlimited.","schema":{"type":"string"}},"X-BoxPDF-Expires-At":{"description":"Token expiry timestamp in ISO-8601, or unlimited.","schema":{"type":"string"}}}},"503":{"description":"Server conversion engine unavailable"}}}},"\/download\/{token}":{"get":{"summary":"Download a generated file using the temporary token","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Binary output file"},"404":{"description":"Expired or invalid download token"}}}}},"components":{"schemas":{"TokenUsage":{"type":"object","properties":{"plan_code":{"type":"string"},"plan_name":{"type":"string"},"token_type":{"type":"string","enum":["api","plugin"]},"consumer_name":{"type":"string"},"daily_limit":{"type":"integer","minimum":0,"description":"Zero means unlimited."},"daily_remaining":{"type":"integer","nullable":true},"monthly_limit":{"type":"integer","minimum":0,"description":"Zero means unlimited."},"monthly_remaining":{"type":"integer","nullable":true},"days_remaining":{"type":"integer","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"validity_status":{"type":"string","enum":["active","expiring","expired","revoked"]}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key"},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-PSM-API-Key"},"BasicAuth":{"type":"http","scheme":"basic","description":"WordPress username and Application Password"}}}}