ContractRabbit Docs
API Reference

Documents

Process getDocumentFilters

POST
/api/documents/{documentId}/get-filters

Path Parameters

documentId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

curl -X POST "https://loading/api/documents/string/get-filters"
null
{
  "message": "string"
}

Bulk delete documents

POST
/api/files/bulk/delete

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/bulk/delete"
null
null
null
null
null
null

Check if OCR text exists for multiple documents

POST
/api/files/bulk/ocr

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/bulk/ocr"
null
null
null
{
  "message": "string"
}

Bulk reprocess documents

POST
/api/files/bulk/reprocess

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/bulk/reprocess"
null
null
null
null
null
null

Get processing status for multiple documents

POST
/api/files/bulk/status

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/bulk/status"
null
null
null
null

Bulk update document metadata

POST
/api/files/bulk/update-metadata

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/bulk/update-metadata"
null
null
null
null
null
null

Bulk update document parties

POST
/api/files/bulk/update-parties

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/bulk/update-parties"
null
null
null
null
null
null

Get Count

GET
/api/files/scoreboard-files/count

Response Body

application/json

application/json

curl -X GET "https://loading/api/files/scoreboard-files/count"
null
{
  "message": "string"
}

Get document analysis

POST
/api/files/{fileId}/analysis

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/analysis"
null
null
null
null

Assign user to document

POST
/api/files/{fileId}/assign

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/assign"
null
null
null
{
  "message": "string"
}

Remove document assignments

DELETE
/api/files/{fileId}/assign

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://loading/api/files/string/assign"
null
null
null
{
  "message": "string"
}

Update document assignment

PUT
/api/files/{fileId}/assign

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://loading/api/files/string/assign"
null
null
null
{
  "message": "string"
}

Get Assignments

GET
/api/files/{fileId}/assignments

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/assignments"
null
null
null
{
  "message": "string"
}

Get all changes for a document

GET
/api/files/{fileId}/changes

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/changes"
null
null
null

Create a new change for a document

POST
/api/files/{fileId}/changes

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/changes"
null
null
null
null

Get document cohort by type

POST
/api/files/{fileId}/document-types/cohort

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/document-types/cohort"
null
null
{
  "message": "string"
}

Get document type dates cohort

POST
/api/files/{fileId}/document-types/dates

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/document-types/dates"
null
null
{
  "message": "string"
}

Get document type scores

POST
/api/files/{fileId}/document-types/scores

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/document-types/scores"
null
null
{
  "message": "string"
}

Get document download URL

GET
/api/files/{fileId}/download

Path Parameters

fileId*string

Response Body

application/json

application/json

curl -X GET "https://loading/api/files/string/download"
null
{
  "message": "string"
}

Execute all document operations

POST
/api/files/{fileId}/execute-all

Path Parameters

fileId*string
curl -X POST "https://loading/api/files/string/execute-all"

Execute redline document generation

GET
/api/files/{fileId}/execute-redline

Path Parameters

fileId*string
curl -X GET "https://loading/api/files/string/execute-redline"

Process post

POST
/api/files/{fileId}/execute-redline-revisions

Path Parameters

fileId*string

Request Body

application/json

body?unknown
curl -X POST "https://loading/api/files/string/execute-redline-revisions"

Get

GET
/api/files/{fileId}/execute-revision

Path Parameters

fileId*string
curl -X GET "https://loading/api/files/string/execute-revision"

Get FileTypeId

GET
/api/files/{fileId}/file-type-id

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/file-type-id"
null
null
{
  "message": "string"
}

Get options for a specific filter

POST
/api/files/{fileId}/filters/{id}/options

Path Parameters

fileId*string
id*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

curl -X POST "https://loading/api/files/string/filters/string/options"
null
{
  "message": "string"
}

Process getFilters

POST
/api/files/{fileId}/get-filters

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

curl -X POST "https://loading/api/files/string/get-filters"
null
{
  "message": "string"
}

Get AiFilters

GET
/api/files/{fileId}/get-filters-ai

Path Parameters

fileId*string

Response Body

application/json

application/json

curl -X GET "https://loading/api/files/string/get-filters-ai"
null
{
  "message": "string"
}

Get RecommendedFilters

GET
/api/files/{fileId}/get-filters-recommended

Path Parameters

fileId*string

Response Body

application/json

application/json

curl -X GET "https://loading/api/files/string/get-filters-recommended"
null
{
  "message": "string"
}

Update LifecycleStage

PUT
/api/files/{fileId}/lifecycle-stage

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X PUT "https://loading/api/files/string/lifecycle-stage"
null
null
{
  "message": "string"
}

List available filters without options

POST
/api/files/{fileId}/list-filters

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

curl -X POST "https://loading/api/files/string/list-filters"
null
{
  "message": "string"
}

Get Matches

GET
/api/files/{fileId}/matches

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/matches"
null
null
{
  "message": "string"
}

Merge document images into PDF

POST
/api/files/{fileId}/merge

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/merge"
null
null
null

Get document name

GET
/api/files/{fileId}/name

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/name"
null
null
{
  "message": "string"
}

Get OCR-extracted text for document

GET
/api/files/{fileId}/ocr

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/ocr"
null
null
{
  "message": "string"
}

Check if OCR text exists for document

HEAD
/api/files/{fileId}/ocr

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X HEAD "https://loading/api/files/string/ocr"
null
null
{
  "message": "string"
}

Get downloadOcr

GET
/api/files/{fileId}/ocr-download

Path Parameters

fileId*string

Response Body

text/plain

application/json

application/json

curl -X GET "https://loading/api/files/string/ocr-download"
null
null
{
  "message": "string"
}

Get RadarData

GET
/api/files/{fileId}/radar

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/radar"
null
null
null

Reprocess document

POST
/api/files/{fileId}/reprocess

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/reprocess"
null
null
{
  "message": "string"
}

Get ScoreboardFiles

GET
/api/files/{fileId}/scoreboard

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/scoreboard"
null
null
null
{
  "message": "string"
}

Create SearchIndex

POST
/api/files/{fileId}/search-index

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/search-index"
null
null
{
  "message": "string"
}

Get document sections

POST
/api/files/{fileId}/sections

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/sections"
null
null
{
  "message": "string"
}

Get SectionsNew

GET
/api/files/{fileId}/sections-new

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/sections-new"
null
null
{
  "message": "string"
}

Get document SFDT

GET
/api/files/{fileId}/sfdt

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/sfdt"
null
null
null
{
  "message": "string"
}

Align document with document type corpus

POST
/api/files/{fileId}/sfdt/document-types-align

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/sfdt/document-types-align"
null
null
{
  "message": "string"
}

Get document statistics and analytics

POST
/api/files/{fileId}/stats

Path Parameters

fileId*string

Request Body

application/json

body?unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/files/string/stats"
null
null
{
  "message": "string"
}

Get document processing status

GET
/api/files/{fileId}/status

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/status"
null
null
null

Update document processing status

PUT
/api/files/{fileId}/status

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

curl -X PUT "https://loading/api/files/string/status"
null
null
{
  "message": "string"
}

Get token frequencies for a document (server-side filtered for exclusions)

GET
/api/files/{fileId}/tokens

Path Parameters

fileId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/files/string/tokens"
null
null
null
null

API Reference

ContractRabbit REST API documentation.

Matters

Next Page