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 Annotations API

The Annotations API from Luminance — 12 operation(s) for annotations.

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

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

This API exposes 18 operations across 12 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://your-instance.app.luminance.com/api2.

18 operations 12 paths 8 schemas 12 GET4 PATCH2 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
Resource Areas
1

Authentication & Security 1

Luminance Annotations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

Paths & Operations 18

Across 12 paths, the API surfaces 18 operations — 12 GET, 4 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Annotations 18
GET
/annotation_types
Get Annotation Types that have been created on your instance as a whole.
9 params → 200401403405422429500
GET
/annotation_types/{annotation-type-id}
Get information on a specific Annotation Type ID
1 param → 200401403405422429500
GET
/projects/{project-id}/matters/{matter-id}/annotations
Get an array of JSON object Annotations added to a matter
9 params → 200401403405422429500
POST
/projects/{project-id}/matters/{matter-id}/annotations
Create an annotation on a matter
2 params body → 200401403405422429500
PATCH
/projects/{project-id}/matters/{matter-id}/annotations
Patch the content of multiple matter annotations to a different value
9 params body → 200401403405422429500
GET
/projects/{project-id}/matters/{matter-id}/annotations/{annotation-id}
Get an array of JSON object Annotations added to a matter
3 params → 200401403405422429500
PATCH
/projects/{project-id}/matters/{matter-id}/annotations/{annotation-id}
Patch the content of a particular matter annotation to a different value
3 params body → 200401403405422429500
GET
/projects/{project-id}/documents/{document-id}/annotations
Get Information on Annotations for a single Document object
10 params → 200401403405422429500
GET
/projects/{project-id}/folders/{folder-id}/documents/{document-id}/annotations
Get Information on Annotations for a single Document object
11 params → 200401403405422429500
GET
/projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}/annotations
Get Information on Annotations for a single Document object
11 params → 200401403405422429500
GET
/projects/{project-id}/documents/{document-id}/annotations/annotationText
Get Information on a Single Annotation
4 params → 200401403405422429500
GET
/projects/{project-id}/folders/{folder-id}/documents/{document-id}/annotations/annotationText
Get Information on a Single Annotation
5 params → 200401403405422429500
GET
/projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}/annotations/annotationText
Get Information on a Single Annotation
5 params → 200401403405422429500
GET
/annotation_sources
Get information on a particular annotationsourceid. Each annotationsource can be used to populate values users are able to select from in-platform when interacting with Matters
10 params → 200401403405422429500
POST
/annotation_sources
Create a new annotationsource
body → 200401403405422429500
PATCH
/annotation_sources
Modify annotationsources
10 params body → 200401403405422429500
GET
/annotation_sources/{annotation_source_id}
Get information on a particular annotationsourceid. Each annotationsource can be used to populate values users are able to select from in-platform when interacting with Matters
1 param → 200401403405422429500
PATCH
/annotation_sources/{annotation_source_id}
Modify annotationsources
1 param body → 200401403405422429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AnnotationSource (8 properties), AnnotationType (8 properties), Annotation (8 properties), MatterAnnotation (7 properties). Each schema is shown below with its type and property counts.

AnnotationSource
object
8 properties
MatterAnnotation
object
7 properties
AnnotationText
object
2 properties
MatterAnnotationPatch
object
3 properties
AnnotationType
object
8 properties
AnnotationSourcePatch
object
Payload required to PATCH an annotationSourceId
5 properties
AnnotationSourceCreate
object
Payload required to POST a new annotationSourceId
4 properties
Annotation
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

luminance-annotations-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 Contract Creation API
Luminance Document Templates API
Luminance Documents 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 Annotations 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.