Relativity

Relativity Conceptual Analytics v1 API

The Conceptual Analytics v1 API from Relativity — 4 operation(s) for conceptual analytics v1.

GitHub OpenAPI

Operations 7

POST /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/ Analytics conceptual service interfaces public v1 IConceptual index service… #
GET /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID} Analytics conceptual service interfaces public v1 IConceptual index service… #
PUT /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID} Analytics conceptual service interfaces public v1 IConceptual index service… #
DELETE /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID} Analytics conceptual service interfaces public v1 IConceptual index service… #
GET /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID}/status Analytics conceptual service interfaces public v1 IConceptual index service get… #
POST /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID}/job Analytics conceptual service interfaces public v1 IConceptual index service… #
DELETE /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID}/job Analytics conceptual service interfaces public v1 IConceptual index service… #

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-conceptual-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-conceptual-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-conceptual-analytics-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1…
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Conceptual Analytics v1
paths:
  /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/:
    post:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.CreateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConceptualIndex'
        required: true
      responses:
        '201':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service…
      x-summary-source: derived
  /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID}:
    get:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/indexID'
      responses:
        '200':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service…
      x-summary-source: derived
    put:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/indexID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConceptualIndex'
        required: true
      responses:
        '200':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service…
      x-summary-source: derived
    delete:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.DeleteAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/indexID'
      responses:
        '200':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service…
      x-summary-source: derived
  /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID}/status:
    get:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.GetStatusAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/indexID'
      responses:
        '200':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service get…
      x-summary-source: derived
  /conceptual-analytics/v1/workspaces/{workspaceID}/indexes/{indexID}/job:
    post:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.SubmitJobAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/indexID'
      - $ref: '#/components/parameters/jobType'
      responses:
        '201':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service…
      x-summary-source: derived
    delete:
      tags:
      - Conceptual Analytics v1
      description: '[Public] IConceptualIndexService'
      operationId: Analytics.Conceptual.Service.Interfaces.Public.v1.IConceptualIndexService.CancelJobAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/indexID'
      responses:
        '200':
          description: Successful Operation
      summary: Analytics conceptual service interfaces public v1 IConceptual index service…
      x-summary-source: derived
components:
  schemas:
    ConceptualIndex:
      title: ConceptualIndex
      type: object
      properties:
        ArtifactID:
          type: integer
        Guids:
          type: array
          items:
            type: string
        AnalyticsServer:
          $ref: '#/components/schemas/ArtifactRef'
        ConceptStopWords:
          type: string
        Dimensions:
          type: integer
        EmailNotificationRecipients:
          type: array
          items:
            type: string
        Name:
          type: string
        OptimizeTrainingSet:
          type: boolean
        Order:
          type: integer
        RemoveEngSignaturesAndFooters:
          type: boolean
        EnableEmailHeaderFilter:
          type: boolean
        RepeatedContentFilters:
          type: array
          items:
            $ref: '#/components/schemas/ArtifactRef'
        SearchableSet:
          $ref: '#/components/schemas/ArtifactRef'
        TrainingSet:
          $ref: '#/components/schemas/ArtifactRef'
        Active:
          type: boolean
        RemoveDocumentErrors:
          type: boolean
        ContinueIndexStepsToCompletion:
          type: boolean
        LastErrorMessage:
          type: string
        IndexLastUsedOn:
          type: string
          format: date-time
        InUseByCategorizationSet:
          type: boolean
    ArtifactRef:
      title: ArtifactRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Guids:
          type: array
          items:
            type: string
  parameters:
    workspaceID:
      name: workspaceID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    jobType:
      name: jobType
      in: query
      description: ''
      required: true
      schema:
        enum:
        - FullPopulation
        - IncrementalPopulation
        - RetryErrors
        - RemoveDocumentsInError
        - Build
        - Activate
        - Deactivate
        - TagDocuments
        type: string
    indexID:
      name: indexID
      in: path
      description: ''
      required: true
      schema:
        type: integer
x-provenance:
  method: harvested
  publisher: Relativity
  source: https://platform.relativity.com/RelativityOne/Content/OASFiles/Analytics.Conceptual.Service.Interfaces.Public.V1.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)