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 Versioned Imaging Module v1 API

The Versioned Imaging Module v1 API from Relativity — 20 operation(s) for versioned imaging module v1.

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

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

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

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

26 operations 20 paths 36 schemas 4 DELETE7 GET15 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 26

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

Versioned Imaging Module v1 26
GET
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.ReadAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.UpdateAsync 3 params body → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/
[Public] IApplicationFieldCodeManager -
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.CreateAsync 2 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/documents/{documentID}/status
[Public] IDocumentStatusManager -
Relativity.Imaging.Services.Interfaces.V1.IDocumentStatusManager.GetStatusAsync 3 params → 200
DELETE
/relativity-imaging/v1/environment/jobs/inactive-jobs
[Public] IImagingEnvironmentManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingEnvironmentManager.CleanupInactiveJobsAsync 1 param → 200
GET
/relativity-imaging/v1/environment/jobs/mass-imaging-max-size
[Public] IImagingEnvironmentManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingEnvironmentManager.GetMaxMassImagingJobSizeAsync 1 param → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/run
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.RunImagingSetAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/retry-errors
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.RetryImagingSetErrorsAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/jobs/{imagingJobID}/stop
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.StopImagingJobAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/documents/{documentArtifactID}/image
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.ImageDocumentAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/documents/mass-image
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.MassImageDocumentsByMassProcessIdAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/jobs/{imagingJobID}/priority
[Public] IImagingJobManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.UpdateJobPriorityAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/basic
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.CreateBasicImagingProfileAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/native
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.CreateNativeImagingProfileAsync 2 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.ReadAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.UpdateAsync 3 params body → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
[Public] IImagingProfileManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.CreateAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.UpdateAsync 3 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.ReadAsync 3 params → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/release-images
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.ReleaseImagingSetAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/hide-images
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.HideImagingSetAsync 3 params → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/status
[Public] IImagingSetManager -
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.GetStatusAsync 3 params → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/native-types/{nativeTypeID}
[Public] INativeTypeManager -
Relativity.Imaging.Services.Interfaces.V1.INativeTypeManager.ReadAsync 3 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are ImagingSetStatusResponse (20 properties), SpreadsheetOptions (17 properties), ImagingProfile (14 properties), ImagingProfileUpdateRequest (13 properties). Each schema is shown below with its type and property counts.

ImagingProfileUpdateRequest
object
13 properties
BasicImagingEngineOptions
object
9 properties
ImagingProfileRef
object
2 properties
ImageOnTheFlyResponse
object
1 property
DocumentWarning
object
2 properties
MassImagingResponse
object
1 property
HtmlOptions
object
1 property
SpreadsheetOptions
object
17 properties
NativeType
object
8 properties
UpdateJobPriorityRequest
object
2 properties
NativeImagingEngineOptions
object
8 properties
ImagingSetStatus
object
7 properties
DocumentStatusResponse
object
4 properties
StopImagingJobRequest
object
1 property
ImagingProfile
object
14 properties
ApplicationFieldCode
object
7 properties
EmailOptions
object
9 properties
ImagingSetCreateRequest
object
4 properties
NativeTypeRef
object
2 properties
ImagingSetRequest
object
2 properties
ImagingSetResponse
object
1 property
ApplicationFieldCodeRef
object
2 properties
ImageOnTheFlyRequest
object
4 properties
ImagingSetUpdateRequest
object
4 properties
PresentationOptions
object
2 properties
ApplicationFieldCodeRequest
object
5 properties
WordProcessingOptions
object
3 properties
DocumentError
object
2 properties
UpdateJobPriorityResponse
object
2 properties
ImagingSetStatusResponse
object
20 properties
NativeImagingProfileCreateRequest
object
12 properties
BasicImagingProfileCreateRequest
object
5 properties
StopImagingJobResponse
object
2 properties
ImagingSet
object
6 properties
MassImageRequest
object
4 properties
FieldRef
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-versioned-imaging-module-v1-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 Versioned Imaging Module v1 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.