Cette API est simple à utiliser. Il vous suffit de suivre ces étapes

• Créer un compte gratuitement
• Cliquez sur le lien reçu par e-mail pour confirmer votre adresse.
• Générer un jeton avec vos identifiants

Vous pouvez utiliser n’importe quel langage pour effectuer cet appel CURL. (Python, PHP, Java, JavaScript...) Besoin d’aide ?

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

Si vos identifiants sont corrects, notre serveur vous fournira un jeton en réponse : {"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}
YOUR_TOKEN est valide pendant une heure ; sa durée peut être prolongée avec YOUR_REFRESH_TOKEN.


• Utilisez le jeton pour démarrer le traitement de façon asynchrone

Paramètres de l’action

Envoyez parameters comme objet JSON. Les champs obligatoires sont marqués obligatoire.

• operationType — string.
• vectorStoreId — string.
• vectorName — string.
• vectorDescription — string.
• urlList — string.
• fileIds — string.
• question — string.
• instructions — string.
• filters — string.
• alsoDeleteGlobal — boolean.
curl --location 'https://mxprocess.com/api/files/start-process' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --form 'file=@"/FILE_PATH/FILE_NAME"' \ --form 'actionName="ManageVector"' \ --form 'parameters={"operationType":"example","vectorStoreId":"example","vectorName":"example","vectorDescription":"example","urlList":"example","fileIds":"example","question":"example","instructions":"example","filters":"example","alsoDeleteGlobal":false}' \ --form 'async="true"' \ --form 'fileUrl=""' \ --form 'fileContent=""'
Si votre fichier est accessible par URL, ignorez le champ « file=@.. » et utilisez directement son URL dans le champ « fileUrl ».

L’API renvoie une réponse JSON confirmant le démarrage du traitement. Notez le champ « trackingUrl », qui permet de suivre le traitement lancé. La réponse contient aussi son identifiant ; dans cet exemple, il s’agit de 643 : { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "ManageVector", "slug": "all-in-one-online-platform-to-create-edit-and-manage-ai-vectors", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": false, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "trackingUrl": "https://mxprocess.com/api/actions/get-action-infos/643" }


• Pour suivre l’avancement, effectuez une simple requête GET (vous pouvez appeler cette URL toutes les 10 secondes) :
curl --location 'https://mxprocess.com/api/actions/get-action-infos/643' \ --header 'Authorization: Bearer YOUR_TOKEN' }}

Si le traitement n’est pas terminé, vous recevrez ce type de réponse avec "accomplished": false { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": null, "endTime": null, "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "ManageVector", "slug": "all-in-one-online-platform-to-create-edit-and-manage-ai-vectors", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": false, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "executionPlannedAt": null, "trackingUrl": "" }

Une fois le traitement terminé, vous recevrez ce type de réponse avec "accomplished": true. Le champ actionResultsDownloadURLs contient les URL authentifiées permettant de télécharger les résultats générés : { "actionResultsDownloadURLs": [ "https://mxprocess.com/api/actions/download-result/643/35084b44a841ec597be3048df44145e8.txt.log/YOUR_TOKEN" ], "id": 643, "actionParameters": { "commandParameters": "" }, "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": "2024-01-28T11:24:49+01:00", "endTime": "2024-01-28T11:25:09+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "ManageVector", "slug": "all-in-one-online-platform-to-create-edit-and-manage-ai-vectors", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": true, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [ [ "35084b44a841ec597be3048df44145e8.txt.log" ] ], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "executionPlannedAt": null, "trackingUrl": "" }

Utilisez directement chaque URL fournie dans actionResultsDownloadURLs pour télécharger le résultat correspondant.

Cette documentation n’est pas claire ? (Python, PHP, Java, JavaScript...) Besoin d’aide ?

Nous contacter Cette API est également disponible en mode synchrone : API développeur : ManageVector