Aller au contenu

Projets, tags et partage

La bibliothèque de fichiers constitue la source unique de vérité pour les ressources ; les projets, les tags et la recherche sont des vues qui les organisent. Conservez les identifiants de fichiers ou de documents ; n’utilisez pas les noms à la place d’identifiants stables.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /api/v1/projects/{project_id}/documents/{document_id}

L’ajout d’un document à un projet ne modifie que son organisation : le fichier n’est pas copié et son propriétaire reste inchangé.

GET /api/v1/tags
POST /api/v1/tags
DELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}
DELETE /api/v1/tags/documents/{document_id}/{tag_id}

Un nom de balise sert à l’affichage ; la suppression, le détachement et les requêtes utilisent l’ID de la balise.

GET /api/v1/search?q={query}&limit=20

La recherche ne renvoie que les documents et les tâches que le compte actuel est autorisé à lire. La recherche est une opération de lecture et n’occasionne aucun crédit.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /api/v1/shares/{token}

POST /shares crée un lien en lecture seule vers un résultat de traduction ; le corps contient artifact_id et un expires_in_days optionnel (1–365 ; sans cet élément, le lien n’expire pas). Toute personne disposant du lien peut le télécharger, veillez donc à ne pas l’inclure dans les journaux ou les paramètres d’analyse, et supprimez-le lorsqu’il n’est plus nécessaire.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

Ces points de terminaison permettent de créer un espace de travail unifié pour un compte OmniDoc. Les clients doivent respecter les entrées et les fonctionnalités indiquées dans les réponses et ne pas générer eux-mêmes les URL des applications.