Luminance

Luminance Annotations API

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

GitHub OpenAPI

Operations 18

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

Documentation

📖
Documentation
https://api.luminance.com/swagger-docsv150
📖
Documentation
https://api.luminance.com/swagger-docsv140
📖
Documentation
https://api.luminance.com/swagger-docsv130

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/luminance/refs/heads/main/openapi/luminance-annotations-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/luminance-annotations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

luminance-annotations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Luminance Annotations API
  version: '1.0'
  description: 'Operations tagged Annotations across 3 of this provider''s published API definitions: luminance-annotations-api-openapi.yml, luminance-api-v1-3-openapi-original.yml, luminance-api-v1-4-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://your-instance.app.luminance.com/api2
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Annotations
paths:
  /annotation_types:
    get:
      tags:
      - Annotations
      summary: Get Annotation Types that have been created on your instance as a whole.
      parameters:
      - $ref: '#/components/parameters/annotationTypeId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/annotationType'
      - $ref: '#/components/parameters/annotationTypeKey'
      - $ref: '#/components/parameters/annotationTypePre-built'
      - $ref: '#/components/parameters/annotationTypeName'
      - $ref: '#/components/parameters/annotationTypeOptions'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_types_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /annotation_types/{annotation-type-id}:
    get:
      tags:
      - Annotations
      summary: Get information on a specific Annotation Type ID
      parameters:
      - $ref: '#/components/parameters/annotation-type-id'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_types_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/matters/{matter-id}/annotations:
    get:
      tags:
      - Annotations
      summary: Get an array of JSON object Annotations added to a matter
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/matter-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/matterAnnotationId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/matterAnnotationTypeId'
      - $ref: '#/components/parameters/annotationContent'
      - $ref: '#/components/parameters/annotationState'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/matter_annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
      - Annotations
      summary: Create an annotation on a matter
      parameters:
      - $ref: '#/components/parameters/matter-id'
      - $ref: '#/components/parameters/project-id'
      requestBody:
        required: true
        content:
          application/json:
            description: Define the annotationTypeId and the annotationContent for it. The content including required property names and data types of an annotation may vary depending on the annotationTypeId
            schema:
              type: object
              properties:
                annotation_type_id:
                  type: integer
                  example: 367
                content:
                  type: object
                  properties:
                    value:
                      type: string
                      example: Agreement
            example:
              annotation_type_id: 344
              content:
                value: Agreement
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_create_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    patch:
      tags:
      - Annotations
      summary: Patch the content of multiple matter annotations to a different value
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/matter-id'
      - $ref: '#/components/parameters/matterAnnotationId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/annotationTypeId'
      - $ref: '#/components/parameters/annotationContent'
      - $ref: '#/components/parameters/matterAnnotationState'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MatterAnnotationPatch'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/matter_annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/matters/{matter-id}/annotations/{annotation-id}:
    get:
      tags:
      - Annotations
      summary: Get an array of JSON object Annotations added to a matter
      parameters:
      - $ref: '#/components/parameters/matter-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/annotation-id'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/matter_annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    patch:
      tags:
      - Annotations
      summary: Patch the content of a particular matter annotation to a different value
      parameters:
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/matter-id'
      - $ref: '#/components/parameters/annotation-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MatterAnnotationPatch'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/matter_annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/documents/{document-id}/annotations:
    get:
      tags:
      - Annotations
      summary: Get Information on Annotations for a single Document object
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/document-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/annotationId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdby'
      - $ref: '#/components/parameters/annotationType'
      - $ref: '#/components/parameters/annotationRoles'
      - $ref: '#/components/parameters/annotationState'
      - $ref: '#/components/parameters/annotationContent'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/folders/{folder-id}/documents/{document-id}/annotations:
    get:
      tags:
      - Annotations
      summary: Get Information on Annotations for a single Document object
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/document-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/folder-id'
      - $ref: '#/components/parameters/annotationId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdby'
      - $ref: '#/components/parameters/annotationType'
      - $ref: '#/components/parameters/annotationRoles'
      - $ref: '#/components/parameters/annotationState'
      - $ref: '#/components/parameters/annotationContent'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}/annotations:
    get:
      tags:
      - Annotations
      summary: Get Information on Annotations for a single Document object
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/document-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/task-id'
      - $ref: '#/components/parameters/annotationId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdby'
      - $ref: '#/components/parameters/annotationType'
      - $ref: '#/components/parameters/annotationRoles'
      - $ref: '#/components/parameters/annotationState'
      - $ref: '#/components/parameters/annotationContent'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotations_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/documents/{document-id}/annotations/annotationText:
    get:
      tags:
      - Annotations
      summary: Get Information on a Single Annotation
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/document-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/annotationTextId'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotationText_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/folders/{folder-id}/documents/{document-id}/annotations/annotationText:
    get:
      tags:
      - Annotations
      summary: Get Information on a Single Annotation
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/document-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/folder-id'
      - $ref: '#/components/parameters/annotationTextId'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotationText_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /projects/{project-id}/tasks/{task-id}/reviews/documents/{document-id}/annotations/annotationText:
    get:
      tags:
      - Annotations
      summary: Get Information on a Single Annotation
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/document-id'
      - $ref: '#/components/parameters/project-id'
      - $ref: '#/components/parameters/task-id'
      - $ref: '#/components/parameters/annotationTextId'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotationText_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /annotation_sources:
    get:
      tags:
      - Annotations
      summary: Get information on a particular annotation_source_id. Each annotation_source can be used to populate values users are able to select from in-platform when interacting with Matters
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/annotationSourceId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/annotationTypeId'
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/workflowId'
      - $ref: '#/components/parameters/annotationSourceRelationId'
      - $ref: '#/components/parameters/annotationContent'
      - $ref: '#/components/parameters/annotationState'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_sources_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
      - Annotations
      summary: Create a new annotation_source
      requestBody:
        description: See schema for options and required information in body of request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnotationSourceCreate'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_source_create_201'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    patch:
      tags:
      - Annotations
      summary: Modify annotation_sources
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/annotationSourceId'
      - $ref: '#/components/parameters/createdAt'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/annotationTypeId'
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/workflowId'
      - $ref: '#/components/parameters/annotationSourceRelationId'
      - $ref: '#/components/parameters/annotationContent'
      - $ref: '#/components/parameters/annotationState'
      requestBody:
        description: See schema for options and required information in body of request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnotationSourcePatch'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_source_patch_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /annotation_sources/{annotation_source_id}:
    get:
      tags:
      - Annotations
      summary: Get information on a particular annotation_source_id. Each annotation_source can be used to populate values users are able to select from in-platform when interacting with Matters
      parameters:
      - $ref: '#/components/parameters/annotationSourceId'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_sources_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    patch:
      tags:
      - Annotations
      summary: Modify annotation_sources
      parameters:
      - $ref: '#/components/parameters/annotationSourceId'
      requestBody:
        description: See schema for options and required information in body of request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnotationSourcePatch'
      security:
      - OAuth2: []
      responses:
        '200':
          $ref: '#/components/responses/annotation_source_patch_200'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
    servers:
    - url: https://your-instance.app.luminance.com/api2
      description: Base URL declared by the provider in apis.yml (roadmap#122).
components:
  parameters:
    createdAt:
      name: created_at
      in: query
      description: Time of Creation
      required: false
      schema:
        type: string
        format: date-time
        minimum: 0
      example: '2021-10-25T11:58:31.879Z'
    matter-id:
      name: matter-id
      in: path
      description: Matter Id
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    annotationTypeName:
      name: name
      in: query
      description: The display name for the annotation in platform
      required: false
      schema:
        type: string
        format: string
        minimum: 0
    annotationTypePre-built:
      name: pre-built
      in: query
      description: Whether this annotation is reflects an out-of-the-box Luminance concept ("True"), or the concept has been created in your instance ("False")
      required: false
      schema:
        type: boolean
        default: none
    annotationTypeKey:
      name: key
      in: query
      description: Key used to identify the annotation
      required: false
      schema:
        type: string
        format: string
    annotationRoles:
      name: roles
      in: query
      description: There will only ever be a single value in the role field for annotations. This corresponds to annotationTypeKey available when calling the /annotation_types endpoint
      required: false
      schema:
        type: array
        example:
        - contract-effective
    annotationType:
      name: type
      in: query
      description: Type of data stored by the annotation e.g. 'language'
      required: false
      schema:
        type: string
        enum:
        - alert
        - alias
        - contract:state
        - contracttype
        - definedterm:definition
        - definedterm:use
        - document:bates
        - document:cluster
        - document:custodian
        - document:duplicationfamily
        - document:family
        - document:privileged
        - document:relation
        - document:textinfo
        - documenttype
        - email:chain
        - email:type
        - emailaddress
        - entity:area
        - entity:boolean
        - entity:custom
        - entity:datetime
        - entity:enum
        - entity:identifier
        - entity:law
        - entity:location
        - entity:money
        - entity:organization
        - entity:party
        - entity:percent
        - entity:person
        - entity:signature
        - entity:term
        - entity:timeperiod
        - folder
        - fragment:clause
        - fragment:cluster
        - generic:boolean
        - generic:enum
        - generic:number
        - generic:text
        - language
        - page
        - pagecount
        - qa:antivirus
        - qa:blankpage
        - qa:contentextraction
        - qa:emptycontent
        - qa:encrypted
        - qa:hiddencells
        - qa:missingmodel
        - qa:ocr
        - qa:paragraphing
        - qa:partiallyindexed
        - qa:render
        - qa:restrictedfileformat
        - qa:unsupportedfileformat
        - redacted
        - search
        - source:referenceid
        - source:signed
        - structure:group
        - structure:metadata
        - structure:pagebreak
        - structure:paragraph:joined
        - structure:paragraph:split
        - structure:section
        - title
        - user
        - usertag
    annotationSourceRelationId:
      name: annotation_source_relation_id
      in: query
      description: annotation_source_relation_id is not currently an interactable element via the API
      required: false
      schema:
        type: integer
        example: 76
        minimum: 0
    matterAnnotationState:
      name: state
      in: query
      description: State of an Annotation attached to a Matter
      required: false
      schema:
        type: string
        enum:
        - active
        - deleted
    annotationSourceId:
      name: annotation_source_id
      in: query
      description: annotation_source_id for a particular value made available to a users selecting values for that an Annotation when interacting with Matters in the user interface
      required: false
      schema:
        type: integer
        example: 76
        minimum: 0
    task-id:
      name: task-id
      in: path
      description: Task ID
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    annotationState:
      name: state
      in: query
      description: State of the annotation
      required: false
      type: string
      enum:
      - active
      - deleted
    limit:
      name: limit
      in: query
      description: Maximum number of objects that can be retrieved.
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
        default: 50
    document-id:
      name: document-id
      in: path
      description: Document ID
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    projectId:
      name: id
      in: query
      description: Unique Project ID
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
    folder-id:
      name: folder-id
      in: path
      description: Folder ID
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    createdBy:
      name: created_by
      in: query
      description: User ID of Creator
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 4
    annotationTypeOptions:
      name: options
      in: query
      description: Options associated with the annotation, the options field will display available values if the type is generic:enum.
      required: false
      schema:
        type: array
        items:
          type: string
    annotation-type-id:
      name: annotation-type-id
      in: path
      description: Annotation Type ID
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    annotationTypeId:
      name: annotation_type_id
      in: query
      description: annotationTypeId for a particular MatterAnnotation. Can be queried via the annotation_types endpoint
      required: false
      schema:
        type: integer
        example: 64
        minimum: 0
    annotation-id:
      name: annotation-id
      in: path
      description: Annotation ID
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    annotationTextId:
      name: id
      in: query
      required: true
      description: This parameter refers to the annotationId you wish to retrieve the underlying text from the Document on. It should be repeated to return results from multiple annotationIds
      schema:
        type: integer
        format: int32
        example: 6238
    matterAnnotationId:
      name: id
      in: query
      description: Annotation ID of an Annotation attached to a Matter
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
    workflowId:
      name: id
      in: query
      description: Unique Workflow ID
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
    matterAnnotationTypeId:
      name: id
      in: query
      description: Unique Annotation Type ID for the Annotation attached to the Matter, can also be queried via the /annotation_types endpoint
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
    annotationContent:
      name: content
      in: query
      description: The content of a particular annotation, which will be a value depending on the annotation's annotationTypeId
      required: false
      schema:
        type: object
        properties:
          value:
            type: string
            example: Agreement
    project-id:
      name: project-id
      in: path
      description: Project ID
      required: true
      schema:
        type: integer
        format: int32
        minimum: 0
    annotationId:
      name: id
      in: query
      description: Unique Annotation ID
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
  responses:
    annotation_create_200:
      description: JSON object of matter annotations after POSTing to create the matter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/annotationId'
          example:
            version: 1.3.0
            api2_version: 1.3.0
            product: corporate
    annotationText_200:
      description: JSON array of clauses (annotation)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AnnotationText'
          example:
            id: 37225093,
            text: Example clause text.
    matter_annotations_200:
      description: JSON array of Annotation objects structured in the below schema
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MatterAnnotation'
          example:
            id: 37495390
            created_at: '2023-04-19T12:20:39.100Z'
            created_by: 4
            matter_id: 7342
            annotation_type_id: 347
            content:
              timestamp: '2027-04-07T00:00:00.000Z'
            state: active
    annotation_source_create_201:
      description: JSON object of an AnnotationsSource after POSTing to create one
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AnnotationSource'
          example:
            id: 56
            created_at: '2021-10-25T11:58:31.879Z'
            created_by: 1
            annotation_type_id: 345
            project_id: 2
            workflow_id: 3
            annotation_source_relation_id: null
            content:
              type: object
              example:
                party: VoicePhone Limited
                raw_text: Voicephone Ltd.
            state: active
    '422':
      description: Unprocessable Entity - the request was well formed, but not processable
    annotation_types_200:
      description: JSON array of annotation type objects available in the instance, or a sinlge JSON annotation type object if annotation type ID is referenced in the path
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AnnotationType'
          example:
            id: 1
            created_at: '2021-10-25T11:58:31.879Z'
            created_by: 1
            type: entity:datetime
            key: contract:effective
            pre-built: true
            name: Effective Date
            options: {}
    '401':
      description: Unauthorized - the authentication provide

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/luminance/refs/heads/main/openapi/luminance-annotations-api-openapi.yml