Execute a knowledge base query

Execute a structured pattern query over the KB. Required scope: write

POST /api/v1/query

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/query' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 20,
  "patterns": [
    {
      "object": "string",
      "predicate": "string",
      "subject": "Replacement tent pole set"
    }
  ]
}'

200

{
  "bindings": [
    {}
  ],
  "execution_time_ms": 250,
  "total_count": 1
}

Execute a structured pattern query over the KB.

Required scope: write

Request body

QueryRequest

limit · integer

patterns · PatternRequest[] · required

Response

QueryResponse

bindings · object[] · required

execution_time_ms · integer (int64) · required

total_count · integer · required

Status codes

Code	Meaning
200	Query executed
400	Invalid query
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/query' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 20,
  "patterns": [
    {
      "object": "string",
      "predicate": "string",
      "subject": "Replacement tent pole set"
    }
  ]
}'

200

{
  "bindings": [
    {}
  ],
  "execution_time_ms": 250,
  "total_count": 1
}