Projekte, Tags und Freigabe
Die Dateibibliothek ist die Quelle der Wahrheit für Ressourcen; Projekte, Tags und die Suche sind Ansichten, die sie organisieren. Behalten Sie Datei- oder Dokument-IDs bei; verwenden Sie keine Namen anstelle stabiler Identifikatoren.
Projekte
Abschnitt betitelt „Projekte“GET /api/v1/projectsPOST /api/v1/projectsGET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documentsDELETE /api/v1/projects/{project_id}/documents/{document_id}Das Hinzufügen eines Dokuments zu einem Projekt ändert lediglich dessen Organisation: Die Datei wird nicht kopiert und ihr Eigentümer bleibt unverändert.
GET /api/v1/tagsPOST /api/v1/tagsDELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}DELETE /api/v1/tags/documents/{document_id}/{tag_id}Ein Tag-Name dient der Anzeige; das Löschen, Trennen und Abfragen erfolgt über die Tag-ID.
GET /api/v1/search?q={query}&limit=20Die Suche liefert nur Dokumente und Jobs, die das aktuelle Konto lesen darf. Die Suche ist ein Lesevorgang und kostet keine Credits.
Links teilen
Abschnitt betitelt „Links teilen“GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares erstellt einen schreibgeschützten Link zu einem Übersetzungsergebnis; der Body enthält artifact_id und optional expires_in_days (1–365; ohne diesen Parameter läuft der Link nicht ab). Jeder, der über den Link verfügt, kann die Datei herunterladen. Daher sollte der Link nicht in Logs oder Analyseparametern enthalten sein und gelöscht werden, sobald er nicht mehr benötigt wird.
App-Arbeitsbereich
Abschnitt betitelt „App-Arbeitsbereich“GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsDiese Endpunkte dienen dem Aufbau eines einheitlichen Arbeitsbereichs für ein OmniDoc-Konto. Clients sollten den Einträgen und Funktionen in den Antworten folgen und keine App-URLs selbst erstellen.