Projecten, tags en delen
De bestandsbibliotheek is de bron van waarheid voor resources; projecten, tags en zoeken zijn weergaven die ze organiseren. Behoud bestands- of document-ID’s; gebruik geen namen in plaats van stabiele identificatoren.
Projecten
Section titled “Projecten”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}Het toevoegen van een document aan een project wijzigt alleen de organisatie: het bestand wordt niet gekopieerd en de eigenaar blijft ongewijzigd.
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}Een tagnaam is bedoeld voor weergave; bij het verwijderen, loskoppelen en queryën wordt de tag-ID gebruikt.
Zoeken
Section titled “Zoeken”GET /api/v1/search?q={query}&limit=20De zoekopdracht retourneert alleen documenten en taken die het huidige account mag lezen. Zoeken is een leestoegang en kost geen credits.
Deel links
Section titled “Deel links”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares maakt een alleen-lezen koppeling naar een vertaalresultaat aan; de body bevat artifact_id en een optionele expires_in_days (1–365; zonder deze verloopt de koppeling niet). Iedereen met de koppeling kan het bestand downloaden, dus houd deze buiten logboeken en analytische parameters en verwijder hem wanneer hij niet langer nodig is.
App-werkruimte
Section titled “App-werkruimte”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsDeze eindpunten zijn bedoeld voor het opzetten van een uniforme werkruimte voor een OmniDoc-account. Clients dienen de vermeldingen en functionaliteiten in de antwoorden te volgen en mogen zelf geen app-URL’s samenstellen.