Relativity DocumentViewerService API

The DocumentViewerService API from Relativity — 1 operation(s) for documentviewerservice.

Documentation GitHub OpenAPI

Operations 1

POST /v{version}/DocumentViewerServiceManager/GetViewerContentKeyAsync Submits a conversion request and returns a viewer content key for document viewer rendering.

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/relativity-documentviewerservice-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

openapi: 3.2.0
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Document Viewer Service API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: DocumentViewerService
paths:
  /v{version}/DocumentViewerServiceManager/GetViewerContentKeyAsync:
    post:
      tags:
      - DocumentViewerService
      summary: Submits a conversion request and returns a viewer content key for document viewer rendering.
      description: 'Supports document, production, image, and file-field conversion scenarios used by the Document Viewer REST API.

        The returned value includes keys used to track conversion and retrieve converted content.'
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Request payload containing workspace, document identifiers, conversion type, and conversion options.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.ViewerContentKeyRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.ViewerContentKeyRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.ViewerContentKeyRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.ViewerContentKey'
            application/json:
              schema:
                $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.ViewerContentKey'
            text/json:
              schema:
                $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.ViewerContentKey'
components:
  schemas:
    Relativity.DocumentViewer.Domain.DTOs.V2.GetViewerContentKeyRequest:
      type: object
      properties:
        WorkspaceId:
          type: integer
          format: int32
        DocumentIds:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        ConversionType:
          $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.ConversionType'
        Priority:
          $ref: '#/components/schemas/Review.Shared.PriorityLevel'
        Options:
          $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.GetViewerContentKeyOptions'
      additionalProperties: false
    Relativity.DocumentViewer.Domain.DTOs.ViewerContentKey:
      type: object
      properties:
        RequestKey:
          type:
          - string
          - 'null'
          format: uuid
        CacheEntryId:
          type:
          - integer
          - 'null'
          format: int64
        DocumentArtifactId:
          type: integer
          format: int32
        ConversionVersion:
          type:
          - string
          - 'null'
        Priority:
          type: integer
          format: int32
        WorkspaceArtifactId:
          type: integer
          format: int32
        ViewerType:
          type: integer
          format: int32
        Priority2ViewerContentKeys:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.ViewerContentKey'
        MinimalFilesManifest:
          type:
          - string
          - 'null'
        ErrorId:
          type: integer
          format: int64
          readOnly: true
        ErrorMessage:
          type:
          - string
          - 'null'
        IsPartialConversion:
          type: boolean
        VersionKey:
          type:
          - string
          - 'null'
        SemanticCacheKey:
          type:
          - string
          - 'null'
        LimitedOutput:
          type: boolean
        PasswordRequested:
          type: boolean
        DocumentPassword:
          type:
          - string
          - 'null'
      additionalProperties: false
    Reviewservice.Api.V2.Models.ViewerContentKeyRequest:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.V2.GetViewerContentKeyRequest'
      additionalProperties: false
    Relativity.DocumentViewer.Domain.ConversionType:
      enum:
      - None
      - Native
      - Image
      - Production
      - Transcript
      - HTMLImage
      - HTMLProduction
      - Text
      - ProducedNative
      - PDF
      type: string
    Review.Shared.PriorityLevel:
      enum:
      - None
      - OnTheFly
      - ConvertAhead
      - MassConvert
      type: string
    Relativity.DocumentViewer.Domain.GetViewerContentKeyOptions:
      type: object
      properties:
        ProductionId:
          type:
          - integer
          - 'null'
          format: int32
        ForceConversion:
          type: boolean
        FileId:
          type:
          - integer
          - 'null'
          format: int32
        DocumentSetId:
          type:
          - string
          - 'null'
        ClientId:
          type:
          - string
          - 'null'
        CorrelationId:
          type: string
          format: uuid
      additionalProperties: false