HTTP API

Check text at a precise step in your application

Example

Check a customer reply with an email-address rule set to Review

HTTP request excerpt

# After approving the estimate for this exact request
POST /v1/check
Authorization: Bearer <scoped key>
Idempotency-Key: <stable event ID>
Content-Type: application/json

{
  "scan_policy_id": "<policy_id>",
  "scan_policy_version": 1,
  "direction": "output",
  "content": "Please contact sam@example.test about order 2041."
}

Result fields

{
  "status": "completed",
  "decision": "review",
  "safe_to_continue": false
}

Email address found

Hold the reply for human review

Forward only completed Allow results with safe_to_continue=true; Review, Block, incomplete results and errors stop the next action

Setup

Configure the service URL and a scoped key in protected storage
Choose a scan policy and pin its version
Estimate the exact request and approve its cost before checking
Route the result before sending text to the next step

Read getting started