Relativity

Relativity WorkspaceJob API

The WorkspaceJob API from Relativity — 2 operation(s) for workspacejob.

GitHub OpenAPI

Operations 2

POST /v1/workspace-job Start workspace creation #
GET /v1/workspace-job/{jobId} Get workspace creation job progress #

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/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://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-workspacejob-api-openapi.yml

Other Resources

🔗
Plans
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/plans/relativity-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/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-workspacejob-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

relativity-workspacejob-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Workspace Service Workspace Job API
  description: 'The Workspace Service API provides a REST service for managing workspace creation and maintenance.


    The URL prefix for workspace services endpoints: https://\/api/workspace-service'
  version: '1'
  x-relativity-api-visibility: public
security:
- Bearer: []
tags:
- name: WorkspaceJob
paths:
  /v1/workspace-job:
    post:
      tags:
      - WorkspaceJob
      summary: Start workspace creation
      description: Starts asynchronous workspace creation and returns a job ID. Use GET /v1/workspace-job/{jobId} to track the progress of the created job.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCreateRequestDto'
          text/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCreateRequestDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/WorkspaceCreateRequestDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WorkspaceCreateEnqueueResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCreateEnqueueResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCreateEnqueueResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '415':
          description: Unsupported Media Type
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Internal Server Error
      operationId: postV1WorkspaceJob
      x-operation-id-source: derived
  /v1/workspace-job/{jobId}:
    get:
      tags:
      - WorkspaceJob
      summary: Get workspace creation job progress
      description: Returns the current step, total steps, state, and workspace artifact ID for a given job. Poll this endpoint to track the progress of a workspace creation started via POST /v1/workspace-job.
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WorkspaceCreateJobResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCreateJobResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCreateJobResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Internal Server Error
      operationId: getV1WorkspaceJobByJobId
      x-operation-id-source: derived
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    WorkspaceCreateRequestDto:
      required:
      - Name
      - UseCase
      type: object
      properties:
        Name:
          maxLength: 50
          minLength: 1
          type: string
        MatterArtifactId:
          type: integer
          format: int32
        StatusArtifactId:
          type: integer
          format: int32
        TemplateArtifactId:
          type: integer
          format: int32
        SqlFullTextLanguage:
          type: integer
          format: int32
        Keywords:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
        Notes:
          type:
          - string
          - 'null'
        DownloadHandlerUrl:
          type:
          - string
          - 'null'
        UseCase:
          minLength: 1
          type: string
        WorkspaceAdminGroupArtifactId:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    WorkspaceCreateJobResponse:
      type: object
      properties:
        JobId:
          type: string
          format: uuid
        WorkspaceArtifactId:
          type:
          - integer
          - 'null'
          format: int32
        TotalNumberOfSteps:
          type:
          - integer
          - 'null'
          format: int32
        CurrentStep:
          type:
          - integer
          - 'null'
          format: int32
        JobState:
          type:
          - string
          - 'null'
        Attempt:
          type: integer
          format: int32
      additionalProperties: false
    WorkspaceCreateEnqueueResponse:
      required:
      - JobId
      type: object
      properties:
        JobId:
          type: string
          format: uuid
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: 'Standard Authorization header using the Bearer scheme. Example: "bearer {token}"'
      scheme: bearer
      bearerFormat: JWT