API Documentation, Convert a PDF or scan into an editable Word document with OCR and layout reconstruction.

API : Convert a PDF or scan into an editable Word document with OCR and layout reconstruction.

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

Action parameters

Send parameters as a JSON object. Required fields are marked with required.

language — enum:auto,en,fr.
preserveImages — boolean.
preserveTables — boolean.
preserveHeaders — boolean.
preserveFooters — boolean.
ocrMode — enum:auto,force,disabled.
outputLanguage — enum:original,translate.
targetLanguage — enum:en,fr,de,es,hi,zh,ar.
imageQuality — enum:low,medium,high.
keepComments — boolean.
keepMetadata — boolean.
repairDamagedPdf — boolean.

curl --location 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'file=@"/FILE_PATH/FILE_NAME"' \
--form 'actionName="PdfToWordWithOcrIa"' \
--form 'parameters={"language":"auto","preserveImages":false,"preserveTables":false,"preserveHeaders":false,"preserveFooters":false,"ocrMode":"auto","outputLanguage":"original","targetLanguage":"en","imageQuality":"low","keepComments":false,"keepMetadata":false,"repairDamagedPdf":false}' \
--form 'async="false"' \
--form 'fileUrl=""' \
--form 'fileContent=""'

If your file is accessible by URL, you can ignore the "file=@.." field and directly use the URL of your file in the "fileUrl" field

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": "PdfToWordWithOcrIa",
        "slug": "pdf-to-word-ocr-ai",
        "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 ?