{"openapi":"3.1.0","info":{"title":"BoxPDF API","version":"1.8.0-phase38-rc1","description":"Public, account and connector APIs for BoxPDF."},"servers":[{"url":"https://boxpdf.ir"}],"tags":[{"name":"Public"},{"name":"Content"},{"name":"Account"},{"name":"Connector"},{"name":"Media"}],"paths":{"/api/v2/offers":{"get":{"tags":["Public"],"summary":"List active offers","responses":{"200":{"$ref":"#/components/responses/JsonSuccess"}}}},"/api/v2/content":{"get":{"tags":["Content"],"summary":"List published articles and guides","parameters":[{"name":"type","in":"query","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"}}}},"/api/v2/content/{article}":{"get":{"tags":["Content"],"summary":"Read published content by slug","parameters":[{"name":"article","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"},"404":{"$ref":"#/components/responses/JsonError"}}}},"/wp-json/boxpdf/v2/media/register":{"post":{"tags":["Media"],"summary":"Register or refresh a BoxWebP site","security":[{"boxpdfHmac":["media"]}],"responses":{"201":{"$ref":"#/components/responses/JsonSuccess"}}}},"/wp-json/boxpdf/v2/media/queue/claim":{"post":{"tags":["Media"],"summary":"Claim media queue work with a renewable lease","security":[{"boxpdfHmac":["media"]}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"}}}},"/wp-json/boxpdf/v2/media/status":{"get":{"tags":["Media"],"summary":"Read BoxWebP media lifecycle status","security":[{"boxpdfHmac":["media"]}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"}}}},"/api/v2/account":{"get":{"tags":["Account"],"summary":"Account summary","security":[{"sanctum":["account:read"]}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"},"401":{"$ref":"#/components/responses/JsonError"}}}},"/api/v2/usage":{"get":{"tags":["Account"],"summary":"Usage ledger","security":[{"sanctum":["usage:read"]}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"}}}},"/wp-json/boxpdf/v2/health":{"get":{"tags":["Connector"],"summary":"Connector health","responses":{"200":{"$ref":"#/components/responses/JsonSuccess"}}}},"/wp-json/boxpdf/v2/capabilities":{"get":{"tags":["Connector"],"summary":"Signed connector capabilities","security":[{"boxpdfHmac":[]}],"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"},"401":{"$ref":"#/components/responses/JsonError"}}}},"/wp-json/boxpdf/v2/convert":{"post":{"tags":["Connector"],"summary":"Submit image/PDF conversion","security":[{"boxpdfHmac":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"$ref":"#/components/responses/JsonSuccess"},"422":{"$ref":"#/components/responses/JsonError"}}}}},"components":{"securitySchemes":{"sanctum":{"type":"http","scheme":"bearer","bearerFormat":"BoxPDF token"},"boxpdfHmac":{"type":"apiKey","in":"header","name":"X-BoxPDF-Signature","description":"Requires Key-Id, Timestamp, Nonce, Content-SHA256 and Signature headers."}},"responses":{"JsonSuccess":{"description":"Successful JSON response","content":{"application/json":{"schema":{"type":"object"}}}},"JsonError":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}}