Aller au contenu

Résultats et téléchargements

GET /api/v1/artifacts?job_id={job_id}
GET /api/v1/artifacts/{artifact_id}

Les artefacts ne sont visibles que par le compte propriétaire. Consultez la liste une fois le travail terminé.

GET /api/v1/artifacts/{artifact_id}/download
Fenêtre de terminal
curl --fail-with-body -OJ \
https://omnidoc.top/api/v1/artifacts/6n2b7z5q8v4m1c3k/download \
-H "X-API-Key: $OMNIDOC_API_KEY"

Les téléchargements prennent en charge ETag et les requêtes conditionnelles. Diffusez les fichiers volumineux sur disque au lieu de les lire entièrement en mémoire.

GET /api/v1/artifacts/{artifact_id}/download-link

Valeurs renvoyées :

{
"mode": "direct",
"url": "https://download.example/...",
"filename": "report.en.docx"
}

Les clients doivent également gérer le fait que url soit null ; puis utiliser le point de terminaison de téléchargement direct. Récupérez une nouvelle URL à court terme après l’expiration de la précédente.

GET /api/v1/artifacts/{artifact_id}/preview-url

Les résultats HTML, SVG et XML sont toujours téléchargés en tant que pièces jointes.

Analysez d’abord RFC 5987 filename*, puis revenez à filename. Quelle que soit la méthode choisie, ne conservez que le nom de base et tronquez ou remplacez les caractères illégaux conformément aux règles de votre système de fichiers local.

Une tâche peut renvoyer plusieurs artefacts ou un seul résultat emballé. Référez-vous au format dans la liste des artefacts et aux en-têtes de réponse du téléchargement ; n’inférez pas le type de réponse à partir de l’extension du fichier source.