Relativity CollectAPI API

The CollectAPI API from Relativity — 6 operation(s) for collectapi.

Documentation GitHub OpenAPI

Operations 6

PUT /collect-services/v1/CollectAPI/{workspaceId}/collection Replace collect services collect api by workspace id collection #

POST /collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/start-target-generation Create collect services collect api by workspace id collection by collection… #

GET /collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/target-generation Get collect services collect api by workspace artifact id collection by… #

PATCH /collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/start-collection Update collect services collect api by workspace artifact id collection by… #

GET /collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId} Get collect services collect api by workspace artifact id collection by… #

PATCH /collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/stop Update collect services collect api by workspace id collection by collection… #

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-collectapi-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

openapi: 3.2.0
info:
  title: collect-api Collect API
  version: '1'
security:
- Bearer:
  - readAccess
  - writeAccess
tags:
- name: CollectAPI
paths:
  /collect-services/v1/CollectAPI/{workspaceId}/collection:
    put:
      tags:
      - CollectAPI
      parameters:
      - name: workspaceArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: x-csrf-header
        in: header
        description: Instance Header
        required: true
        schema:
          type: string
          default: '-'
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CreateCollectionAPIModel'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollectionAPIModel'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateCollectionAPIModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateCollectionAPIModel'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
      summary: Replace collect services collect api by workspace id collection
      x-summary-source: derived
      operationId: putCollectServicesV1CollectAPIByWorkspaceIdCollection
      x-operation-id-source: derived
  /collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/start-target-generation:
    post:
      tags:
      - CollectAPI
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: x-csrf-header
        in: header
        description: Instance Header
        required: true
        schema:
          type: string
          default: '-'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
      summary: Create collect services collect api by workspace id collection by collection…
      x-summary-source: derived
      operationId: postCollectServicesV1CollectAPIByWorkspaceIdCollectionByCollectionArtifactIdStartTargetGeneration
      x-operation-id-source: derived
  /collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/target-generation:
    get:
      tags:
      - CollectAPI
      parameters:
      - name: workspaceArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: collectionArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/StringListActionResult'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
      summary: Get collect services collect api by workspace artifact id collection by…
      x-summary-source: derived
      operationId: getCollectServicesV1CollectAPIByWorkspaceArtifactIdCollectionByCollectionArtifactIdTargetGeneration
      x-operation-id-source: derived
  /collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/start-collection:
    patch:
      tags:
      - CollectAPI
      parameters:
      - name: workspaceArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: collectionArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: x-csrf-header
        in: header
        description: Instance Header
        required: true
        schema:
          type: string
          default: '-'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StartJobResultActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/StartJobResultActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/StartJobResultActionResult'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
      summary: Update collect services collect api by workspace artifact id collection by…
      x-summary-source: derived
      operationId: patchCollectServicesV1CollectAPIByWorkspaceArtifactIdCollectionByCollectionArtifactIdStartCollection
      x-operation-id-source: derived
  /collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}:
    get:
      tags:
      - CollectAPI
      parameters:
      - name: workspaceArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: collectionArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CollectionJobModelActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionJobModelActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/CollectionJobModelActionResult'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResult'
      summary: Get collect services collect api by workspace artifact id collection by…
      x-summary-source: derived
      operationId: getCollectServicesV1CollectAPIByWorkspaceArtifactIdCollectionByCollectionArtifactId
      x-operation-id-source: derived
  /collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/stop:
    patch:
      tags:
      - CollectAPI
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: collectionArtifactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: x-csrf-header
        in: header
        description: Instance Header
        required: true
        schema:
          type: string
          default: '-'
      responses:
        '202':
          description: Accepted
        '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'
        '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'
        '409':
          description: Conflict
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Update collect services collect api by workspace id collection by collection…
      x-summary-source: derived
      operationId: patchCollectServicesV1CollectAPIByWorkspaceIdCollectionByCollectionArtifactIdStop
      x-operation-id-source: derived
components:
  schemas:
    StartJobResult:
      type: object
      properties:
        Success:
          type: boolean
        Message:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionJobModelActionResult:
      type: object
      properties:
        Result:
          $ref: '#/components/schemas/ActionResult'
        Value:
          $ref: '#/components/schemas/CollectionJobModel'
      additionalProperties: false
    SelectedCollectionCriteriaModel:
      type: object
      properties:
        DataType:
          type:
          - string
          - 'null'
        FieldName:
          type:
          - string
          - 'null'
        Operator:
          type:
          - string
          - 'null'
        Value:
          type:
          - string
          - 'null'
        CriteriaDataType:
          $ref: '#/components/schemas/CriteriaDataType'
      additionalProperties: false
    CollectionJobTargetModel:
      type: object
      properties:
        ArtifactId:
          type: integer
          format: int32
        Target:
          type:
          - string
          - 'null'
        SourceInstance:
          type:
          - string
          - 'null'
        Items:
          type: integer
          format: int32
        Errors:
          type: integer
          format: int32
        Size:
          type: integer
          format: int64
        StatusMessage:
          type:
          - string
          - 'null'
        State:
          type:
          - string
          - 'null'
      additionalProperties: false
    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: {}
    SourceInstanceModel:
      type: object
      properties:
        ArtifactId:
          type: integer
          format: int32
        Criteria:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SelectedCollectionCriteriaModel'
      additionalProperties: false
    ActionResult:
      type: object
      additionalProperties: false
    CriteriaDataType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      x-enumNames:
      - Unknown
      - String
      - Integer
      - Date
      - Boolean
      - Guid
      - Decimal
      type: integer
      format: int32
    CreateCollectionAPIModel:
      type: object
      properties:
        CollectionName:
          type:
          - string
          - 'null'
        MatterArtifactId:
          type: integer
          format: int32
        ProcessingSourceLocation:
          type:
          - string
          - 'null'
        JobNumber:
          type:
          - string
          - 'null'
        ZipCollectedFiles:
          type: boolean
        ZipPassword:
          type:
          - string
          - 'null'
        AutoProcessing:
          type: boolean
        AutoProcessingWorkspaceId:
          type: integer
          format: int32
        AutoProcessingProcessingProfileId:
          type: integer
          format: int32
        SelectedDocumentNumberingPrefixOption:
          type:
          - string
          - 'null'
        NotificationEmail:
          type:
          - string
          - 'null'
        SendEmailNotification:
          type: boolean
        Description:
          type:
          - string
          - 'null'
        SourceInstances:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SourceInstanceModel'
        Entities:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        NoncustodialInstances:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
      additionalProperties: false
    StartJobResultActionResult:
      type: object
      properties:
        Result:
          $ref: '#/components/schemas/ActionResult'
        Value:
          $ref: '#/components/schemas/StartJobResult'
      additionalProperties: false
    CollectionJobModel:
      type: object
      properties:
        ArtifactId:
          type: integer
          format: int32
        Name:
          type:
          - string
          - 'null'
        Status:
          type:
          - string
          - 'null'
        Targets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CollectionJobTargetModel'
      additionalProperties: false
    StringListActionResult:
      type: object
      properties:
        Result:
          $ref: '#/components/schemas/ActionResult'
        Value:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: 'Relativity Identity Service (RIS) bearer token to authenticate: https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API_authentication.htm#Bearertokenauthentication'
      scheme: bearer
      bearerFormat: JWT