Relativity

Relativity Structured Analytics v1 API

The Relativity Structured Analytics v1 API from Relativity — 10 operation(s) for relativity structured analytics v1.

GitHub OpenAPI

Operations 13

POST /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs Relativity structured analytics V1 jobs IJob manager run async #
GET /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs Relativity structured analytics V1 jobs IJob manager get status async #
POST /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/prep Relativity structured analytics V1 jobs IJob manager run analysis preparation… #
POST /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/copy-to-legacy Relativity structured analytics V1 jobs IJob manager run copy to legacy async #
DELETE /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/copy-to-legacy Relativity structured analytics V1 jobs IJob manager cancel copy to legacy async #
DELETE /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/ Relativity structured analytics V1 jobs IJob manager cancel async #
POST /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/retry Relativity structured analytics V1 jobs IJob manager retry errors async #
GET /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/tmq Relativity structured analytics V1 jobs IJob manager get TMQ entry async #
GET /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/errors Relativity structured analytics V1 jobs IJob manager get errors async #
GET /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/doc-errors Relativity structured analytics V1 jobs IJob manager get document errors async #
POST /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/doc-errors Relativity structured analytics V1 jobs IJob manager get document errors async #
GET /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/valid-tasks Relativity structured analytics V1 jobs IJob manager get valid tasks async #
DELETE /relativity-structured-analytics/v1/workspaces/{workspaceID}/choices Relativity structured analytics V1 jobs IJob manager remove all choices async #

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://artifacts.apis.io/relativity/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://artifacts.apis.io/relativity/openapi/relativity-relativity-structured-analytics-v1-api-openapi.yml

Other Resources

🔗
Plans
https://artifacts.apis.io/relativity/plans/relativity-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/relativity/finops/relativity-finops.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/relativity:relativity-relativity-structured-analytics-v1-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

relativity-relativity-structured-analytics-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Relativity.StructuredAnalytics.Jobs.V1 Relativity…
  description: Relativity.StructuredAnalytics.Jobs
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Relativity Structured Analytics v1
paths:
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs:
    post:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RunAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalysisSettings'
        required: true
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager run async
      x-summary-source: derived
    get:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetStatusAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
      summary: Relativity structured analytics V1 jobs IJob manager get status async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/prep:
    post:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RunAnalysisPreparationAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager run analysis preparation…
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/copy-to-legacy:
    post:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RunCopyToLegacyAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager run copy to legacy async
      x-summary-source: derived
    delete:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.CancelCopyToLegacyAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager cancel copy to legacy async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/:
    delete:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.CancelAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/wait'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager cancel async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/retry:
    post:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RetryErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager retry errors async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/tmq:
    get:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetTMQEntryAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MasterJob'
      summary: Relativity structured analytics V1 jobs IJob manager get TMQ entry async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/errors:
    get:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/length'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StructuredAnalyticsSetError'
      summary: Relativity structured analytics V1 jobs IJob manager get errors async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/doc-errors:
    get:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetDocumentErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/length'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentError'
      summary: Relativity structured analytics V1 jobs IJob manager get document errors async
      x-summary-source: derived
    post:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: postRelativityStructuredAnalyticsV1WorkspacesByWorkspaceIDSetsBySasArtifactIDJobsDocErrors
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SASDocumentErrorsRequestObject'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SASDocumentErrorsResponseObject'
      summary: Relativity structured analytics V1 jobs IJob manager get document errors async
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetDocumentErrorsAsync
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/valid-tasks:
    get:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetValidTasksAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/sasArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidTaskResult'
      summary: Relativity structured analytics V1 jobs IJob manager get valid tasks async
      x-summary-source: derived
  /relativity-structured-analytics/v1/workspaces/{workspaceID}/choices:
    delete:
      tags:
      - Relativity Structured Analytics v1
      description: '[Public] IJobManager -'
      operationId: Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RemoveAllChoicesAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
      summary: Relativity structured analytics V1 jobs IJob manager remove all choices async
      x-summary-source: derived
components:
  schemas:
    MasterJob:
      title: MasterJob
      type: object
      properties:
        TaskID:
          type: integer
        WorkspaceID:
          type: integer
        ResourceGroupID:
          type: integer
        Status:
          type: integer
        JobArtifactID:
          type: integer
        Handled:
          type:
          - string
          - 'null'
          format: date-time
        DBLocation:
          type: string
        Retries:
          type: integer
        PopulateAll:
          type: boolean
        AnalyzeAll:
          type: boolean
        StatusAtCancel:
          type: integer
        UpgradeStatusComplete:
          type:
          - boolean
          - 'null'
        InitiatorGuid:
          type:
          - string
          - 'null'
    StructuredAnalyticsSetError:
      title: StructuredAnalyticsSetError
      type: object
      properties:
        FullText:
          type: string
        Message:
          type: string
        Server:
          type: string
        Source:
          type: string
    SASDocumentErrorsResponseObject:
      title: SASDocumentErrorsResponseObject
      type: object
      properties:
        DocumentErrors:
          type: array
          items:
            $ref: '#/components/schemas/DocumentError'
        TotalCount:
          type: integer
    ValidTaskResult:
      title: ValidTaskResult
      type: object
      properties:
        ValidTasks:
          type: array
          items:
            enum:
            - CANCEL_ANALYSIS
            - RETRY_ERRORS
            - GET_SET_ERRORS
            - GET_DOCUMENT_ERRORS
            - COPY_TO_LEGACY
            - COPY_TO_LEGACY_CANCEL
            - PREPARE_ANALYSIS
            - RUN_ANALYSIS
            type: string
        CopyToLegacyQualified:
          type: boolean
    OperationState:
      title: OperationState
      type: object
      properties:
        Operation:
          enum:
          - EmailThreading
          - TextualNearDuplicateID
          - LanguageID
          - RepeatedContentID
          - NameNormalizationID
          type: string
        Phase:
          enum:
          - Not_Started
          - Setup
          - SyncingData
          - CalculatingFileSizes
          - QueuedForExport
          - Exporting
          - CompletedExporting
          - QueuedForAnalysis
          - RunningOperations
          - CompletedOperations
          - QueuedForImport
          - ImportingEntityAndAliases
          - Importing
          - Finalizing
          - Completed
          - CompletedWithErrors
          - Error
          - RetryErrors
          - Canceling
          - Canceled
          - MissingFields
          - CopyToLegacyInProgress
          - CopyToLegacyCancelling
          - PreparingAnalysisInProgress
          - PreparingAnalysisCompleted
          - PreparingAnalysisError
          - Unknown
          type: string
        LastActivity:
          type:
          - string
          - 'null'
          format: date-time
    DocumentError:
      title: DocumentError
      type: object
      properties:
        DocumentArtifactID:
          type: integer
        DocumentIdentifier:
          type: string
        Message:
          type: string
        Operations:
          type: array
          items:
            enum:
            - EmailThreading
            - TextualNearDuplicateID
            - LanguageID
            - RepeatedContentID
            - NameNormalizationID
            type: string
        Status:
          enum:
          - IncludedInSet
          - RemovedFromSet
          - DataWarning
          type: string
        DateErrored:
          type: string
          format: date-time
    OperationResult:
      title: OperationResult
      type: object
      properties:
        IsSuccess:
          type: boolean
        Message:
          type: string
    AnalysisSettings:
      title: AnalysisSettings
      type: object
      properties:
        PopulateAll:
          type: boolean
        AnalyzeAll:
          type: boolean
    Status:
      title: Status
      type: object
      properties:
        JobName:
          type: string
        JobState:
          $ref: '#/components/schemas/JobState'
        OperationState:
          type: array
          items:
            $ref: '#/components/schemas/OperationState'
        JobResults:
          $ref: '#/components/schemas/JobResults'
    JobState:
      title: JobState
      type: object
      properties:
        Status:
          type: string
        Phase:
          enum:
          - Not_Started
          - Setup
          - SyncingData
          - CalculatingFileSizes
          - QueuedForExport
          - Exporting
          - CompletedExporting
          - QueuedForAnalysis
          - RunningOperations
          - CompletedOperations
          - QueuedForImport
          - ImportingEntityAndAliases
          - Importing
          - Finalizing
          - Completed
          - CompletedWithErrors
          - Error
          - RetryErrors
          - Canceling
          - Canceled
          - MissingFields
          - CopyToLegacyInProgress
          - CopyToLegacyCancelling
          - PreparingAnalysisInProgress
          - PreparingAnalysisCompleted
          - PreparingAnalysisError
          - Unknown
          type: string
        IsRunning:
          type: boolean
        IsRunningOperations:
          type: boolean
        IsCompleted:
          type: boolean
        IsCanceled:
          type: boolean
        IsCanceling:
          type: boolean
        IsQueued:
          type:
          - boolean
          - 'null'
        IsUnknown:
          type: boolean
        PhaseProgressPercentage:
          type: number
        JobTimeElapsed:
          type: integer
        OperationTimeElapsed:
          type: integer
    SASDocumentErrorsRequestObject:
      title: SASDocumentErrorsRequestObject
      type: object
      properties:
        Sorts:
          type: array
          items:
            type: string
        Filters:
          type: array
          items:
            type: string
        Start:
          type: integer
        Length:
          type: integer
    NameNormalizationStatistics:
      title: NameNormalizationStatistics
      type: object
      properties:
        AliasesIdentified:
          type: integer
        NewAliasesImported:
          type: integer
    JobResults:
      title: JobResults
      type: object
      properties:
        DocumentsAnalyzed:
          type: integer
        EmailThreadingStats:
          $ref: '#/components/schemas/EmailThreadingStatistics'
        NameNormalizationStats:
          $ref: '#/components/schemas/NameNormalizationStatistics'
        TextualNearDupeStats:
          $ref: '#/components/schemas/TextualNearDuplicatesStatistics'
    EmailThreadingStatistics:
      title: EmailThreadingStatistics
      type: object
      properties:
        EmailsAnalyzed:
          type: integer
        InclusiveEmails:
          type: integer
        DocumentsAnalyzed:
          type: integer
    TextualNearDuplicatesStatistics:
      title: TextualNearDuplicatesStatistics
      type: object
      properties:
        AverageSimilarityPercentage:
          type: number
        GroupsCount:
          type: integer
        DocumentsAnalyzed:
          type: integer
  parameters:
    start:
      name: start
      in: query
      description: ''
      schema:
        type: integer
        default: 0
    workspaceID:
      name: workspaceID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'
    wait:
      name: wait
      in: query
      description: ''
      schema:
        type: boolean
        default: false
    length:
      name: length
      in: query
      description: ''
      schema:
        type: integer
        default: 0
    sasArtifactID:
      name: sasArtifactID
      in: path
      description: ''
      required: true
      schema:
        type: integer