API Documentation, BusinessContinuityExercisePack

Synchronous API: AI Business Continuity Exercise Pack

Use this mode only when the client can wait for local text extraction and AI analysis. The request is multipart/form-data and requires a Bearer JWT.

curl --location --request POST 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'file=@"/path/to/business-continuity-plan.pdf"' \
--form 'actionName="BusinessContinuityExercisePack"' \
--form 'parameters=[["language",["English"]],["organizationContext",["a SaaS company"]],["exerciseObjective",["validate recovery coordination"]]]' \
--form 'async=false'

A successful response contains businessContinuityExercisePack and downloadResults. The JSON listed in results is a downloadable file, never an AJAX response to interpret.

{"output":{"businessContinuityExercisePack":{"title":"Business continuity tabletop exercise"},"downloadResults":[["continuity-business-continuity-exercise-pack.json","https://storage.example/..."]]},"0":{"id":123,"accomplished":true}}

Functional error example

{"error":"ERROR_BCEP005 Business Continuity Exercise Pack documents are limited to 80 MB."}

This API is also available in asynchronous mode: asynchronous API.