Lifecycle of documents

In Aluma, documents are resources that are created via the API. In order to perform redaction, classification, data extraction or OCR on a file on disk, a document must first be created in Aluma from that file.

In general, there are 3 steps that must be performed to process a file:

  1. Create a document from the file
  2. Process the document using the read, classify, extract or redact endpoints
  3. Delete the document

๐Ÿ“˜

Inactive documents are deleted automatically after 10 minutes

As a security measure, any documents that have not been used for 10 minutes are automatically deleted. When integrating Aluma into your own system you should delete documents explicitly when you are finished with them rather than relying on this mechanism.

When using the dashboard or CLI, this process is handled automatically for you.

If you are using the HTTP API, you must call the Create document and Delete document endpoints explicitly.

By default, you can have up to 30 documents present in Aluma per API client at any one time. Should you wish to wish to raise that limit, please contact us.