Skip to content
Ishvana Ishvana Docs

Check Mechanics Stream

POST
/api/agents/ruleslawyer/check-mechanics/stream

Stream a mechanics check via NDJSON for progressive UI updates.

Events:

  • {type: "step", message: "..."} — progress indicator
  • {type: "mechanics_loaded", ...} — ruleset info
  • {type: "result", data: MechanicsCheckData} — final result
  • {type: "error", message: "..."} — failure

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
project_id
required
Project Id

Project ID

string

Project ID

Request Body required

Section titled “Request Body required ”
MechanicsCheckRequest
object
content
Content
string
""
documentId
Any of:
string
checkMode
CheckMode
string
default: both
Allowed values: strict narrative both
includeSuggestions
Includesuggestions
boolean
default: true

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

422

Section titled “422 ”

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