API Documentation, SupplierIntelligence

Synchronous API: AI Supplier Intelligence

Use synchronous mode only when the HTTP client can wait for semantic catalogue indexing and AI reference review. 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/supplier-catalogues.zip"' \
--form 'actionName="SupplierIntelligence"' \
--form 'parameters=[["language",["English"]],["supplierName",[""]]]' \
--form 'async=false'

Accepted input is one CSV or a ZIP containing 1–200 CSV catalogues. Successful output contains supplierIntelligence and downloadResults; the persisted action is under key 0.

{"output":{"supplierIntelligence":{"catalogue_count":2,"product_count":184},"downloadResults":[["supplier-intelligence.json","https://storage.example/..."]]},"0":{"id":123,"accomplished":true}}

Functional error example

{"error":"ERROR_SIP005 AI Supplier Intelligence received an invalid ZIP archive."}

For queued processing, use the asynchronous API.