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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Relativity

Relativity Versioned Imaging Module v1 API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity Versioned Imaging Module v1 API is one of 52 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}
Relativity imaging services interfaces V1 IApplication field code manager read…
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.ReadAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
Relativity imaging services interfaces V1 IApplication field code manager…
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.UpdateAsync 3 params body → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/{applicationFieldCodeID}
Relativity imaging services interfaces V1 IApplication field code manager…
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/application-field-codes/
Relativity imaging services interfaces V1 IApplication field code manager…
Relativity.Imaging.Services.Interfaces.V1.IApplicationFieldCodeManager.CreateAsync 2 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/documents/{documentID}/status
Relativity imaging services interfaces V1 IDocument status manager get status…
Relativity.Imaging.Services.Interfaces.V1.IDocumentStatusManager.GetStatusAsync 3 params → 200
DELETE
/relativity-imaging/v1/environment/jobs/inactive-jobs
Relativity imaging services interfaces V1 IImaging environment manager cleanup…
Relativity.Imaging.Services.Interfaces.V1.IImagingEnvironmentManager.CleanupInactiveJobsAsync 1 param → 200
GET
/relativity-imaging/v1/environment/jobs/mass-imaging-max-size
Relativity imaging services interfaces V1 IImaging environment manager get max…
Relativity.Imaging.Services.Interfaces.V1.IImagingEnvironmentManager.GetMaxMassImagingJobSizeAsync 1 param → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/run
Relativity imaging services interfaces V1 IImaging job manager run imaging set…
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.RunImagingSetAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/retry-errors
Relativity imaging services interfaces V1 IImaging job manager retry imaging…
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.RetryImagingSetErrorsAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/jobs/{imagingJobID}/stop
Relativity imaging services interfaces V1 IImaging job manager stop imaging job…
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.StopImagingJobAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/documents/{documentArtifactID}/image
Relativity imaging services interfaces V1 IImaging job manager image document…
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.ImageDocumentAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/documents/mass-image
Relativity imaging services interfaces V1 IImaging job manager mass image…
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.MassImageDocumentsByMassProcessIdAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/jobs/{imagingJobID}/priority
Relativity imaging services interfaces V1 IImaging job manager update job…
Relativity.Imaging.Services.Interfaces.V1.IImagingJobManager.UpdateJobPriorityAsync 3 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/basic
Relativity imaging services interfaces V1 IImaging profile manager create basic…
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.CreateBasicImagingProfileAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/native
Relativity imaging services interfaces V1 IImaging profile manager create…
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.CreateNativeImagingProfileAsync 2 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
Relativity imaging services interfaces V1 IImaging profile manager read async
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.ReadAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
Relativity imaging services interfaces V1 IImaging profile manager update async
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.UpdateAsync 3 params body → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-profiles/{imagingProfileID}
Relativity imaging services interfaces V1 IImaging profile manager delete async
Relativity.Imaging.Services.Interfaces.V1.IImagingProfileManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/
Relativity imaging services interfaces V1 IImaging set manager create async
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.CreateAsync 2 params body → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
Relativity imaging services interfaces V1 IImaging set manager update async
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.UpdateAsync 3 params body → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
Relativity imaging services interfaces V1 IImaging set manager read async
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.ReadAsync 3 params → 200
DELETE
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}
Relativity imaging services interfaces V1 IImaging set manager delete async
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.DeleteAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/release-images
Relativity imaging services interfaces V1 IImaging set manager release imaging…
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.ReleaseImagingSetAsync 3 params → 200
POST
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/hide-images
Relativity imaging services interfaces V1 IImaging set manager hide imaging set…
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.HideImagingSetAsync 3 params → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/imaging-sets/{imagingSetID}/status
Relativity imaging services interfaces V1 IImaging set manager get status async
Relativity.Imaging.Services.Interfaces.V1.IImagingSetManager.GetStatusAsync 3 params → 200
GET
/relativity-imaging/v1/workspaces/{workspaceID}/native-types/{nativeTypeID}
Relativity imaging services interfaces V1 INative type manager read async
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.

ImagingSetCreateRequest
object
4 properties
StopImagingJobRequest
object
1 property
FieldRef
object
4 properties
ImageOnTheFlyResponse
object
1 property
BasicImagingProfileCreateRequest
object
5 properties
ImagingSet
object
6 properties
ApplicationFieldCodeRequest
object
5 properties
ApplicationFieldCodeRef
object
2 properties
ImagingSetRequest
object
2 properties
WordProcessingOptions
object
3 properties
ApplicationFieldCode
object
7 properties
BasicImagingEngineOptions
object
9 properties
MassImagingResponse
object
1 property
PresentationOptions
object
2 properties
ImagingSetStatusResponse
object
20 properties
ImagingProfile
object
14 properties
SpreadsheetOptions
object
17 properties
HtmlOptions
object
1 property
EmailOptions
object
9 properties
DocumentWarning
object
2 properties
UpdateJobPriorityRequest
object
2 properties
ImagingSetUpdateRequest
object
4 properties
UpdateJobPriorityResponse
object
2 properties
ImagingSetResponse
object
1 property
ImagingProfileRef
object
2 properties
DocumentError
object
2 properties
ImagingProfileUpdateRequest
object
13 properties
NativeType
object
8 properties
ImagingSetStatus
object
7 properties
NativeTypeRef
object
2 properties
DocumentStatusResponse
object
4 properties
NativeImagingProfileCreateRequest
object
12 properties
ImageOnTheFlyRequest
object
4 properties
StopImagingJobResponse
object
2 properties
MassImageRequest
object
4 properties
NativeImagingEngineOptions
object
8 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
AE Profile APIs.io
Relativity ArchiveJobs API
AE Profile APIs.io
Relativity ARM Module v1 API
AE Profile APIs.io
Relativity ARM Module v3 API
AE Profile APIs.io
Relativity BillableSummaryReports API
AE Profile APIs.io
Relativity BillingConfiguration API
AE Profile APIs.io
Relativity BillingInsights API
AE Profile APIs.io
Relativity Client Side Libraries Module API
AE Profile APIs.io
Relativity ColdStorage API
AE Profile APIs.io
Relativity CollectAPI API
AE Profile APIs.io
Relativity Conceptual Analytics v1 API
AE Profile APIs.io
Relativity Directory API
AE Profile APIs.io
#Versioned Imaging Module v1
← Back to R APIs
API Details
ID
relativity:relativity-versioned-imaging-module-v1-api
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Docs
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
Provider
Relativity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=relativity-versioned-imaging-module-v1-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/relativity-versioned-imaging-module-v1-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

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.