Skip to content

List Checks

GET
/api/agents/ruleslawyer/checks

List recent mechanics checks for a project.

project_id
required
Project Id

Project ID

string

Project ID

limit
Limit
integer
default: 10 >= 1 <= 100
offset
Offset
integer
0

Successful Response

MechanicsCheckListPage

Paginated list of mechanics checks.

object
items
required
Items
Array<object>
MechanicsCheckListItem

Summary of a persisted mechanics check.

object
id
required
Id
string
documentId
required
Documentid
string
projectId
required
Projectid
string
rulesetId
required
Rulesetid
string
checkMode
required
Checkmode
string
checkedAt
required
Checkedat
integer
overallScore
required
Overallscore
number
statViolations
required
Statviolations
integer
formulaViolations
required
Formulaviolations
integer
proseMismatches
required
Prosemismatches
integer
totalIssues
required
Totalissues
integer
criticalIssues
required
Criticalissues
integer
analysisNotes
Any of:
string
total
required
Total
integer
offset
required
Offset
integer
limit
required
Limit
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object