Desk

Index one project file as a document

Changed on

Uploads the file as a document of the project's owner, in the organization the project is shared with, and starts its processing; a document the file was indexed as before is deleted. In a project connected to a collection, a file indexed as one of the collection's documents replaces that document's file instead (409 while the document still processes its previous file), and a new document is added to the collection, in the folder the file's directory is. Counts against the owner's page limit, whoever asks. A file already indexed at its current content, and not failed, is not sent again: its record is the answer.

post/api/v0/desk/projects/{project_id}/index

Request

Path parameters

project_idstring uuid required

Request body

pathstring required

Response

Successful Response

filePathstring required
sha256string required
documentIdstring uuid required
jobStatusIdstring
status'processing' | 'indexed' | 'error' required
errorMessagestring nullable

Changes