How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Luminance Documents API

The Documents API from Luminance — 19 operation(s) for documents.

Luminance Documents API is one of 21 APIs that Luminance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 19 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{moniker}.app.luminance.com.

27 operations 19 paths 3 schemas 8 DELETE16 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://your-instance.app.luminance.com/api2
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Luminance Documents API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearerAuth — Access token from the OAuth2 client credentials flow. See the Authentication section above for how to obtain a token (curl to your instance token endpoint); th…

Paths & Operations 27

Across 19 paths, the API surfaces 27 operations — 8 DELETE, 16 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 27
GET
/projects/{project-id}/documents
Get Information on a Document collection
13 params → 200401403405422429500
DELETE
/projects/{project-id}/documents
Delete a collection of Documents.
3 params → 204401403405422429500
POST
/projects/{project-id}/documents/{document-id}/traffic_light_analysis
Initiates Traffic Light Analysis on a document
2 params body → 202401403405422429500
GET
/projects/{project-id}/documents/{document-id}
Get Information on a Single Document
2 params → 200401403405422429500
DELETE
/projects/{project-id}/documents/{document-id}
Delete a Single Document
2 params → 204401403405422429500
GET
/projects/{project-id}/folders/{folder-id}/documents
Get Information on a Document collection
14 params → 200401403405422429500
DELETE
/projects/{project-id}/folders/{folder-id}/documents
Delete a Document collection in a specific folder path
4 params → 204401403405422429500
GET
/projects/{project-id}/folders/{folder-id}/documents/{document-id}
Get Information on a single Document in a specific folder path
3 params → 200401403405422429500
DELETE
/projects/{project-id}/folders/{folder-id}/documents/{document-id}
Delete a Document object in a specific folder path
3 params → 204401403405422429500
GET
/projects/{project-id}/tasks/{task-id}/reviews/documents
Get Information on a Document collection in a specific task
14 params → 200401403405422429500
DELETE
/projects/{project-id}/tasks/{task-id}/reviews/documents
Delete multiple documents in a particular task path
4 params → 204401403405422429500
GET
/projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}
Get Information on a single Document in a specific task path
3 params → 200401403405422429500
DELETE
/projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}
Delete a single Document in a particular task path
4 params → 204401403405422429500
GET
/projects/{project-id}/documents/{document-id}/download
Downloads the file content for a single Document object
3 params → 200401403405422429500
GET
/projects/{project-id}/folders/{folder-id}/documents/{document-id}/download
Downloads the file content for a single Document object
4 params → 200401403405422429500
GET
/projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}/download
Downloads the file content for a single Document object
4 params → 200401403405422429500
POST
/projects/{project-id}/folders/{folder-id}/upload
Upload a single document to a specific folder path
6 params body → 200401403405422429500
GET
/api2/projects/{project_id}/documents
List documents in a project
10 params → 200
DELETE
/api2/projects/{project_id}/documents
Delete documents by filter
2 params → 204
GET
/api2/projects/{project_id}/documents/{document_id}
Get document
2 params → 200404
DELETE
/api2/projects/{project_id}/documents/{document_id}
Delete single document
2 params → 204404
GET
/api2/projects/{project_id}/documents/{document_id}/download
Download document data file
3 params → 200403404422
POST
/api2/projects/{project_id}/documents/{document_id}/traffic_light_analysis
Start traffic light analysis for a document
2 params body → 202422
GET
/api2/projects/{project_id}/documents/{document_id}/annotations
List document annotations
7 params → 200
GET
/api2/projects/{project_id}/documents/{document_id}/annotations/annotationText
Retrieve annotation text
4 params → 200422
GET
/api2/projects/{project_id}/documents/{document_id}/notes
List document notes
2 params → 200
GET
/api2/projects/{project_id}/documents/{document_id}/notes/{id}
Get document note
3 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Document_3 (12 properties), Document_2 (12 properties), Document (12 properties). Each schema is shown below with its type and property counts.

Document
object
12 properties
Document_2
object
Document object (see API2Schema documents table)
12 properties
Document_3
object
Document object (see API2Schema documents table)
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

luminance-documents-api-openapi.yml Raw ↑

Other APIs Luminance publishes across the network.

Luminance Accounts API
Luminance Annotation Source Relations API
Luminance Annotation Sources API
Luminance Annotation Types API
Luminance Annotations API
Luminance Contract Creation API
Luminance Document Templates API
Luminance Folders API
Luminance Matter Versions API
Luminance Matters API
Luminance Project Users API
Luminance Projects API
Where this information came from

This is an independent, third-party profile of Luminance Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.