API REFERENCE
Score one message against your rules and get back a verdict: allow, flag or block, with the winning rule as the reason. One synchronous call, under a second round trip.
Every new workspace starts with a dk_test_ key, shown once at sign-up. Lost it? Create another in API keys. Test keys run the same model and never count toward your allowance.
Copy the example request. Set SIGILLINE_API_KEY and SIGILLINE_API_URL in your environment.
allowDeliver the message.
flagDeliver or hold it, and queue it for a person to review.
blockDon't deliver it. Show reason.name to your moderators.
Send your key as a bearer token. Keys belong to one project. Call the API from your server, never from a browser or app.
A missing or unknown key returns 401 unauthenticated. A revoked key returns 403 forbidden.
Bearer dk_live_… or dk_test_….
application/json
Up to 255 printable ASCII characters. Replays the stored response for 24 hours without billing again.
Your id for the call, echoed back. Generated when absent. Quote it when you contact support.
The API rejects anything over a limit with 400. It never truncates.
The contract version you built against. Use "2026-10-18".
"moderation". Other task names are reserved and return 400 today.
The message to decide on. Up to 2,000 characters. Not stored unless history is on.
Where it was sent. Rules scoped to the other channel are skipped, not scored.
Who sent it.
1 to 16 rules. Order matters: it is the final tie-break.
Your stable id: 1–64 letters, digits, _ or -. Unique within the request.
Up to 64 characters. Returned as reason.name.
Up to 240 characters. What the rule catches, in plain words. This is what the model reads.
What a match means.
0 to 1. A score at or above it matches. Defaults to 0.5.
Up to 3, each up to 120 characters. Short real messages the rule should catch.
"public", "private" or both. Defaults to both.
Up to 5 earlier turns, oldest first. Each is { sender_role, text } with text up to 500 characters.
Your id for the message. Echoed back in the response.
A hint such as "en". The response reports the language used.
Reserved. Sending it returns 400 until saved rulebooks can be used on this call. Sending it together with rules also returns 400.
When true, the response includes ttcMs. Defaults to false.
The decision id. Always present, even when history is off.
The contract version. The current version is "2026-10-18".
"moderation".
The strictest action among matched rules, or allow when none matched.
The winning rule’s score. With no match, 1 minus the highest score. Not a calibrated probability.
The winning rule’s key, name and description, exactly as you sent them. Null when nothing matched.
Every scored rule, in request order: key, action, score, threshold, matched.
Rules that were not scored, each with a reason such as "channel".
code and supported. Unsupported languages cap confidence at 0.2; the verdict stands.
id and version of the model that scored the call. A threshold tuned on one version does not carry to another.
decisions is 1 for a counted call and 0 for a replay or test key. quota_remaining is the organization’s remaining allowance (omitted for test keys).
Echoed when you sent one.
Milliseconds from receiving the request to the response. Present when the request set includeTtc.
The model returns a score per rule. The verdict is computed from those scores the same way every time.
An allow rule never cancels a matched flag or block. It only wins when nothing stricter matched.
Every error has the same shape: error.type, code, message and request_id. Branch on code. The message names the field and the limit, and never quotes the chat text. Errors are never billed.
| STATUS | CODE | WHEN | RETRY |
|---|---|---|---|
| 400 | invalid_request | Schema or limit failed. The message names the field. | No. Fix the request. |
| 401 | unauthenticated | Missing or unknown key. | No. |
| 403 | forbidden | Revoked or expired key. | No. |
| 409 | idempotency_conflict | Same Idempotency-Key, different body. | No. Use a new key. |
| 413 | input_too_large | Rules and message exceed the model’s input budget. | No. Shorten rules. |
| 429 | quota_exceeded | The allowance is used up. | No. Wait or upgrade. |
| 429 | rate_limited | Per-key rate limit. | Yes, after Retry-After. |
| 503 | model_unavailable | Model down or queue full. | Yes, with backoff. |
| 503 | internal_error | A failure other than the model. The body is not allow. | Yes, with backoff. |
400invalid_request
Schema or limit failed. The message names the field.
RetryNo. Fix the request.
401unauthenticated
Missing or unknown key.
RetryNo.
403forbidden
Revoked or expired key.
RetryNo.
409idempotency_conflict
Same Idempotency-Key, different body.
RetryNo. Use a new key.
413input_too_large
Rules and message exceed the model’s input budget.
RetryNo. Shorten rules.
429quota_exceeded
The allowance is used up.
RetryNo. Wait or upgrade.
429rate_limited
Per-key rate limit.
RetryYes, after Retry-After.
503model_unavailable
Model down or queue full.
RetryYes, with backoff.
503internal_error
A failure other than the model. The body is not allow.
RetryYes, with backoff.
A 503 is never an allow. If the model can't answer, you get an error, not a guess. Decide your fallback in code: hold the message, or deliver it and review later.
Send an Idempotency-Key, such as your message id, on every call. A retry with the same key and body returns the stored response for 24 hours, with usage.decisions: 0, so it isn't billed twice. The same key with a different body returns 409. The stored response contains no message text.
Retry rate_limited after Retry-After seconds, and model_unavailable with exponential backoff. Don't retry other errors unchanged.
If the rules and message together exceed the model's input budget, the call returns 413 input_too_large. Shorten descriptions and examples first.
Versioning. schema_version pins the contract you built against. A breaking change ships under a new date. The current version is 2026-10-18.
Usage. One successful call is one decision, however many rules it scores. Errors, replays and test keys don't count. Past the allowance, calls return 429 quota_exceeded.
Data. Message text is not stored. Sigilline keeps the verdict, the winning rule key, language and latency. History is opt-in per project.
Language. English is supported in v1. Other languages still get a verdict, with confidence capped at 0.2.