Aller au contenu

Outils de documentation et de gestion des fichiers

OmniDoc propose des outils de fichiers synchrones et des opérations documentaires asynchrones traçables. Appelez d’abord les points de terminaison de la fonctionnalité ; n’intégrez pas en dur les formats ou limites pris en charge dans le client.

GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

Ces éléments renvoient les opérations actuellement ouvertes, leurs formats d’entrée, ainsi que leurs limites de facturation et techniques. Les capacités répertoriées sous unavailable ne peuvent pas être créées.

POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

Cet endpoint nécessite un Idempotency-Key. kind comprend actuellement :

  • extract : extraction structurée, gratuite.
  • pdf_to_html : de PDF à en ligne HTML, gratuit.
  • visual_extract : extraction structurée visuelle, facturée à la page (1 crédit par page). Avant le démarrage, le nombre de pages pouvant être traitées est déterminé par le solde (au maximum 20 pages) ; si le solde ne couvre pas une page, le code 402 est renvoyé. À l’issue du traitement, seules les pages effectivement traitées sont facturées, ce qui peut entraîner un solde négatif.

Interroger et annuler :

GET /api/v1/document-operations/{operation_id}
GET /api/v1/document-operations?limit=25
POST /api/v1/document-operations/{operation_id}/cancel

Une fois terminée, la réponse output_document_id peut être enregistrée dans la bibliothèque de fichiers ou affectée à une autre tâche, et credit_operation_id fournit le relevé de règlement.

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

Exemple de fusion :

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

Exemple de fractionnement :

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

Les outils n’acceptent que les documents dont le compte actuel est propriétaire et dont le type correspond. Transmettez les réponses binaires en flux continu, et extrayez le nom et le type du fichier des en-têtes de réponse.