Luminance provides a RESTful, HTTP-based API that uses JSON as its primary serialisation format and OAuth2 for authentication.
The API is designed to allow your software to integrate directly with Luminance using our objects and endpoints. Through the API, you can:
Access folders, tasks, and documents stored in Luminance
Track document progress using reviews
Access machine learning outputs via annotations
All API calls must be authenticated using an authorisation header.
Download our full API documentation here.
Objects Available in the Luminance API
The following objects are accessible through the Luminance API:
Accounts: Represents each company’s instance of Luminance.
Users: Represents the users within your Luminance account. A user’s level of access depends on their assigned permissions.
Projects: Refers to the projects stored within your Luminance account.
Tasks: Collections of documents within a project that can be assigned to a subset of users.
Reviews: Represents the review of documents by users within a task.
Folders: Refers to the folders where documents are stored within a project.
Documents: Represents the documents within your Luminance account. Documents can be accessed through their associated projects, folders, or tasks. They can also be uploaded or downloaded via folders.
Annotations: Represents the different types of data tags that can be added to a document. Annotations can be accessed directly via the document they belong to, or through the document’s associated project, folder, or task.