Zum Inhalt springen

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.

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}

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/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}

Ein Tag-Name dient der Anzeige; das Löschen, Trennen und Abfragen erfolgt über die Tag-ID.

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

Die Suche liefert nur Dokumente und Jobs, die das aktuelle Konto lesen darf. Die Suche ist ein Lesevorgang und kostet keine Credits.

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 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.

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

Diese 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.