List all registered predicates

Required scope: read

GET /api/v1/types/predicates

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/types/predicates' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "predicates": [
    {
      "arg_types": [],
      "arity": 1,
      "doc": "string",
      "name": "Two-Person Tent",
      "return_type": "string"
    }
  ],
  "total": 102
}

Required scope: read

Query parameters

limit · integer

Maximum number of items to return (1-1000, default: 50)

offset · integer

Number of items to skip (default: 0)

cursor · string

Cursor for cursor-based pagination (alternative to offset)

sort · string

Sort field with optional direction prefix (- for descending) Examples: ‘created_at’, ‘-name’, ‘confidence’

Response

ListPredicatesResponse

predicates · PredicateResponse[] · required

Show PredicateResponse

arg_types · string[] · required

arity · integer · required

doc · string

name · string · required

return_type · string

total · integer · required

Status codes

Code	Meaning
200	List of predicates
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 GET \
  --url 'https://api.nsr.stateset.com/api/v1/types/predicates' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "predicates": [
    {
      "arg_types": [],
      "arity": 1,
      "doc": "string",
      "name": "Two-Person Tent",
      "return_type": "string"
    }
  ],
  "total": 102
}