Skip to content

Get Check

GET
/api/agents/ruleslawyer/checks/{check_id}

Get a single mechanics check with all its issues.

check_id
required
Check Id
string
project_id
required
Project Id

Project ID

string

Project ID

Successful Response

MechanicsCheckDetail

Full mechanics check with issues.

object
check
required
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
issues
required
Issues
Array<object>
MechanicsIssueData
object
id
required
Id
string
checkId
required
Checkid
string
entityName
Any of:
string
statKey
Any of:
string
formulaKey
Any of:
string
issueSource
required
Issuesource
string
severity
required
Severity
string
description
required
Description
string
context
Any of:
string
suggestedFix
Any of:
string
confidence
Any of:
number
mode
required
Mode
string
status
Status
string
default: open
resolvedAt
Any of:
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