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-activityList reading sessions (with search, filters and paging). -
POST
/ocr-activityCreate a new reading session. -
PATCH
/ocr-activity/bulkUpdate 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.
No standard operations match these filters.
Additional Operations
13-
GET
/ocr-activity/complianceClause compliance report: which contracts contain the expected clauses. -
GET
/ocr-activity/compliance/landscapeClause compliance overview across the whole portfolio. -
GET
/ocr-activity/compliance/csvDownload the clause compliance report as a spreadsheet. -
GET
/ocr-activity/soeBlocksReportReport of extracted text blocks for the Statement of Engagement. -
POST
/ocr-activity/exportSoeBlocksDataDownload the Statement of Engagement blocks as a spreadsheet. -
GET
/ocr-activity/clauseTree/vendorsClause explorer: list vendors. -
GET
/ocr-activity/clauseTree/vendors/{vendorId}/contractsClause explorer: list a vendor's contracts. -
GET
/ocr-activity/clauseTree/contracts/{contractId}/filesClause explorer: list a contract's documents. -
GET
/ocr-activity/clauseTree/files/{fileId}/blocksClause explorer: list the clauses in a document. -
GET
/ocr-activity/{ocractivityId}/statisticsShow statistics for a reading session (pages, sections, topics found). -
GET
/ocr-activity/{ocractivityId}/csvDownload a reading session's results as a spreadsheet. -
GET
/ocr-activity/contained-items-countCount the sections and topics found in reading sessions. -
POST
/ocr-activity/{ocractivityId}/archiveArchive a reading session.
No additional operations match these filters.
No endpoints on Reading sessions match
Try another method, a shorter term, or search the whole API.