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

Relativity PersistentHighlightService API

The PersistentHighlightService API from Relativity — 4 operation(s) for persistenthighlightservice.

Relativity PersistentHighlightService API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PersistentHighlightService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

4 operations 4 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 4

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

PersistentHighlightService 4
GET
/v{version}/workspaces/{workspaceID}/documents/{documentID}/highlight-sets
Retrieves persistent highlight sets and terms applied to a specific document.
3 params → 200
POST
/v{version}/workspaces/{workspaceID}/highlights/{persistentHighlightSetID}/state
Changes the active state of a persistent highlight set or selected terms.
3 params body → 200
GET
/v{version}/workspaces/{workspaceID}/highlight-sets
Retrieves all persistent highlight sets and terms available in a workspace.
2 params → 200
POST
/v{version}/workspaces/{workspaceID}/highlights/{persistentHighlightSetID}/add-terms
Adds one or more new terms to an existing persistent highlight set.
3 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Relativity.DocumentViewer.Services.V2.PersistentHighlightSetDTO (9 properties), Relativity.DocumentViewer.Domain.DTOs.PersistentHighlightTerm (8 properties), Reviewservice.Api.V2.Models.SavePersistentHighlightSetStateRequest (4 properties), Relativity.DocumentViewer.Domain.DTOs.AddHighlightTermsToSetRequest (3 properties). Each schema is shown below with its type and property counts.

Reviewservice.Api.V2.Models.AddPersistentHighlightTermsRequest
object
3 properties
Relativity.DocumentViewer.Services.V2.PersistentHighlightSetDTO
object
9 properties
Relativity.DocumentViewer.Domain.DTOs.PersistentHighlightStateAction
string
Relativity.DocumentViewer.Domain.DTOs.PersistentHighlightTerm
object
8 properties
Reviewservice.Api.V2.Models.SavePersistentHighlightSetStateRequest
object
4 properties
Relativity.DocumentViewer.Domain.DTOs.AddHighlightTermsToSetRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-persistenthighlightservice-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API
Where this information came from

This is an independent, third-party profile of Relativity PersistentHighlightService 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.