API Documentation, فحص أي ملف مع التجزئة وMIME الحقيقي وإشارة أولية لمكافحة الفيروسات والبيانات الوصفية ومعلومات الوسائط وقواعد الكشف ومعاينة OCR.

API : فحص أي ملف مع التجزئة وMIME الحقيقي وإشارة أولية لمكافحة الفيروسات والبيانات الوصفية ومعلومات الوسائط وقواعد الكشف ومعاينة OCR.

This API is simple to use. You just have to follow these steps

Create a free account
Click on the link you receive by email to confirm your address
Generate a token with credentials

You can use any language to make this CURL call. (Python, PHP, Java, JavaScript...) Need help ?

curl --location --request POST 'https://mxprocess.com/api/login_check' \
                                        --header 'Content-Type: application/json' \
                                        --data-raw '{"username":"YOUR_LOGIN","password":"YOUR_PASSWORD"}'

If your credentials are correct, our server will provide you with a token as a response :

{"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}

YOUR_TOKEN is valid for one hour, its duration can be extended using YOUR_REFRESH_TOKEN

Use the token to start the process

API Documentation, FileInspection

Downloading results: when it is present in an API response, actionResultsDownloadURLs contains the authenticated URLs for downloading each generated result file.

Asynchronous API: universal file inspection

Submit one non-empty file up to 50 MiB. The original is read but never moved, changed or deleted. The report is diagnostic: the antivirus engine result is a preliminary triage signal, and the included detection rule set is only a minimal starting set.

Endpoint: POST https://mxprocess.com/api/files/start-process
Authentication: Bearer JWT
Cost: 12 tokens, charged after success.

Start an inspection

curl --location --request POST 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'actionName=FileInspection' \
--form 'file=@/path/to/file.bin' \
--form 'parameters=[]' \
--form 'async=true'

Save the returned id and poll /api/actions/get-action-infos/{id} with the same JWT. When complete, actionResults contains one authenticated downloadable *.inspection.json file.

Initial response

{"id":123,"action":{"actionName":"FileInspection","slug":"inspect-file-online"},"accomplished":false,"actionResults":[],"trackingUrl":"https://mxprocess.com/api/actions/get-action-infos/123"}

Completed report

{
  "fileName": "photo.jpg",
  "sizeBytes": 24576,
  "sha256": "...",
  "mimeDetected": "image/jpeg",
  "mimeDeclared": null,
  "antivirusSignal": {"status": "clean", "detail": "preliminary triage signal"},
  "exif": {"ImageWidth": 800, "ImageHeight": 600},
  "mediaProbe": null,
  "detectionRules": {"status": "clean", "matches": [], "ruleset": "minimal detection rule set"},
  "ocrText": "Complete text detected in the image...",
  "generatedAt": "2026-09-12T12:00:00+00:00"
}

If an optional local tool is unavailable, its section is returned as not_run or null. An invalid cardinality, inaccessible file or file over 50 MiB is rejected before analysis.

The API sends a JSON response to confirm that the process is finished. Download the generated files with the authenticated URLs in actionResultsDownloadURLs.


{
    "actionResultsDownloadURLs": [
        "https://mxprocess.com/api/actions/download-result/1016/a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3/YOUR_TOKEN"
    ],
    "id": 1016,
    "actionParameters": [],
    "dateOfDemand": "2024-02-07T20:51:42+00:00",
    "startTime": "2024-02-07T20:51:46+01:00",
    "endTime": "2024-02-07T20:51:46+01:00",
    "hostedFileIds": [
        {
            "fileId": 1025,
            "parameters": ""
        }
    ],
    "action": {
        "actionName": "FileInspection",
        "slug": "inspect-file-online",
        "jsonRequestSample": null,
        "jsonResponseSample": null,
        "specificDeveloperRequestDocumentation": null,
        "specificDeveloperResponseDocumentation": null,
        "longDescription": null
    },
    "user": [],
    "accomplished": true,
    "userIsNotifiedByEmail": "off",
    "userIsNotifiedByPostQuery": "off",
    "actionResults": [
        [
            "a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3",
            "https://mxprocessfiles.s3.eu-west-1.amazonaws.com/AudioToGPT/1016/a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3"
        ]
    ],
    "priceInTokensAtTimeOfUse": 15,
    "retryCount": 0,
    "executionPlannedAt": null,
    "trackingUrl": ""
}

This documentation is not clear? (Python, PHP, Java, JavaScript...) Need help ?