Execute NSR-L code (facts, rules, queries)

Required scope: write

POST /api/v1/nsrl/execute

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/nsrl/execute' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "human(socrates). mortal(X) :- human(X). ?- mortal(socrates).",
  "persist": true
}'

200

{
  "errors": [
    "string"
  ],
  "execution_time_ms": 250,
  "facts_added": 1,
  "query_results": [
    {
      "bindings": [],
      "confidence": 7.5,
      "proof_steps": [],
      "query": "string",
      "result": true
    }
  ],
  "rules_added": 1,
  "success": true
}

Required scope: write

Request body

NSRLExecuteRequest

code · string · required

NSR-L code to execute

persist · boolean

Whether to persist facts/rules to the org-scoped NSR-L program store (and mirror compatible items into the KB)

Response

NSRLExecuteResponse

errors · string[] · required

Errors (if any)

execution_time_ms · integer (int64) · required

Execution time in milliseconds

facts_added · integer · required

Facts added

query_results · QueryResultResponse[] · required

Query results (for ?- queries)

Show QueryResultResponse

bindings · object[] · required

confidence · number (double) · required

proof_steps · string[]

query · string · required

result · boolean · required

rules_added · integer · required

Rules added

success · boolean · required

Whether execution succeeded

Status codes

Code	Meaning
200	Execution result
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/nsrl/execute' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "human(socrates). mortal(X) :- human(X). ?- mortal(socrates).",
  "persist": true
}'

200

{
  "errors": [
    "string"
  ],
  "execution_time_ms": 250,
  "facts_added": 1,
  "query_results": [
    {
      "bindings": [],
      "confidence": 7.5,
      "proof_steps": [],
      "query": "string",
      "result": true
    }
  ],
  "rules_added": 1,
  "success": true
}