API

Compile and save instruction

Compile a Watch DSL script and persist it as an instruction for transaction evaluation.

POST/compile-and-save-instruction

Use this endpoint to compile a Watch DSL script and save it as an instruction. Once saved, Watch evaluates incoming transactions against the compiled rule. For DSL syntax and examples, see Watch rule examples.

Body

scriptstringrequiredbody

The Watch DSL script to compile. The rule name is extracted from the script and must be unique across instructions.

curl -X POST http://localhost:8081/compile-and-save-instruction \
  -H "Content-Type: application/json" \
  -d '{
    "script": "rule HighValueTransaction {\n    description \"Review any transaction above $10,000\"\n    when amount > 10000\n    then review\n         score   0.5\n         reason  \"Amount exceeds threshold\"\n}"
  }'

{
  "id": 1,
  "name": "HighValueTransaction",
  "text": "rule HighValueTransaction {\n    description \"Review any transaction above $10,000\"\n    when amount > 10000\n    then review\n         score   0.5\n         reason  \"Amount exceeds threshold\"\n}",
  "description": "Review any transaction above $10,000",
  "dsl_json": "{\"name\":\"HighValueTransaction\",\"when\":[...],\"then\":{...}}",
  "created_at": "2026-03-16T10:00:00Z",
  "updated_at": "2026-03-16T10:00:00Z"
}

Missing required field: script cannot be empty

Failed to save instruction: An instruction with name 'HighValueTransaction' already exists.

Failed to compile script: ...

Response

idinteger

Auto-generated instruction ID. Use this with get instruction and delete instruction.

namestring

Unique rule name extracted from the DSL script.

textstring

Original Watch DSL script text.

descriptionstring

Rule description from the DSL script, if provided.

dsl_jsonstring

Compiled rule JSON used during transaction evaluation.

created_atstring

ISO 8601 timestamp of when the instruction was created.

updated_atstring

ISO 8601 timestamp of when the instruction was last updated.