Aller au contenu principal

Trouvez votre prochain outil

API/Référence/Traiter un document
POST/api/v1/documents/{documentId}/process

Traiter un document

Créez une tâche de traitement asynchrone pour une version d’un document du compte.

Authentification

Clé d’API ou authentification du compte

Portées

documents:read, jobs:create

Contrat

API v1

Requête

curl -X POST 'https://api.maxscanner.app/api/v1/documents/{documentId}/process' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "operation": "convert", "format": "pdf" }'

Corps de la requête

{ "operation": "convert", "format": "pdf" }

Réponse

{ "jobId": "job_123", "documentId": "doc_123", "versionId": "ver_4", "status": "queued" }

Notes d’implémentation

  • Le serveur vérifie la propriété du document avant la mise en file.
  • Utilisez le jobId renvoyé pour suivre l’état.

Essayer cet endpoint

Utilisez le bac à sable de l’API pour vous authentifier et tester sans risque avant d’intégrer l’endpoint à votre application.

Ouvrir le bac à sable →