Skip to content

Reading sessions

A reading session is one run of Brooklyn reading a contract document, with its progress and results.

Base path
/ocr-activity

Endpoints

20 endpoints

Method

Standard Operations

7
  • GET /ocr-activity List reading sessions (with search, filters and paging).
  • POST /ocr-activity Create a new reading session.
  • PATCH /ocr-activity/bulk Update several reading sessions at once.
  • GET /ocr-activity/{id} Open a single reading session.
  • PUT /ocr-activity/{id} Replace a reading session's details in full.
  • PATCH /ocr-activity/{id} Edit a reading session.
  • DELETE /ocr-activity/{id} Delete a reading session.

Additional Operations

13
  • GET /ocr-activity/compliance Clause compliance report: which contracts contain the expected clauses.
  • GET /ocr-activity/compliance/landscape Clause compliance overview across the whole portfolio.
  • GET /ocr-activity/compliance/csv Download the clause compliance report as a spreadsheet.
  • GET /ocr-activity/soeBlocksReport Report of extracted text blocks for the Statement of Engagement.
  • POST /ocr-activity/exportSoeBlocksData Download the Statement of Engagement blocks as a spreadsheet.
  • GET /ocr-activity/clauseTree/vendors Clause explorer: list vendors.
  • GET /ocr-activity/clauseTree/vendors/{vendorId}/contracts Clause explorer: list a vendor's contracts.
  • GET /ocr-activity/clauseTree/contracts/{contractId}/files Clause explorer: list a contract's documents.
  • GET /ocr-activity/clauseTree/files/{fileId}/blocks Clause explorer: list the clauses in a document.
  • GET /ocr-activity/{ocractivityId}/statistics Show statistics for a reading session (pages, sections, topics found).
  • GET /ocr-activity/{ocractivityId}/csv Download a reading session's results as a spreadsheet.
  • GET /ocr-activity/contained-items-count Count the sections and topics found in reading sessions.
  • POST /ocr-activity/{ocractivityId}/archive Archive a reading session.