Skip to main content

Technical documentation

Marion Frei
  • Updated

OpenAPI documentation

The OpenAPI documentation for axesPAC v3 (and v2) is available here. Please use an online Swagger editor to display it in a human-friendly format if needed.

Base URL

https://api.axes4.com/sense/ is deprecated and will be removed on 31 December 2026.

Please use https://api.axes4.com/pac/ as your base URL.

File size limit

axesPAC has a size limit of 80 MB per PDF file.

Version 3

Release date

2026-08-10

Release Notes

Changed Endpoints

All endpoints now contain the subscription ID as part of the URL. Some endpoints were removed; they are available under a new base URL.

v2 v3
/v2/jobs /v3/subscription/{subscriptionId}/jobs
/v2/jobs/{jobId}/report/summary /v3/subscription/{subscriptionId}/jobs/{jobId}/report/summary
/v2/jobs/{jobId}/report/details /v3/subscription/{subscriptionId}/jobs/{jobId}/report/details
/v2/apiKey/valid [removed] Replacement available, see https://api.axes4.com/usage/pages/public/openapi/v3
/v2/apiKey/usage [removed] Replacement available, see https://api.axes4.com/usage/pages/public/openapi/v3

Changes

  • Removed author from the summary report

Version 2

Version 2 of the API is deprecated and will be removed by 31 December 2026.

Breaking change

The header name api-key was changed to x-api-key on 10 August 2026.

New Endpoints

  • /v2/apiKey/usage can be used to determine the usage of your API key (number of pages).

Changes

Jobs POST /v2/jobs

  v1 v2
Defective PDF documents Returns a 422 Unprocessable Entity status code Only the respective check and its subordinate checks are terminated, resulting in Severity = terminated
Transmission base64 JSON application/pdf or application/octet-stream
File size limit 20 MB (since September 9, 2025) 80 MB

Summary report GET /v2/jobs/{jobId}/report/summary

  v1 v2
Check node ID name "id" "checkId"
Issues – Added "issueId"

Detailed report GET /v2/jobs/{jobId}/report/details

  v1 v2
Check node ID name "id" "checkId"
Issues – Added "issueId"

Report Retention

All reports are stored for 60 days and can be accessed during this period. After that, they are permanently deleted.