Get a specific predicate signature

Required scope: read

GET /api/v1/types/predicates/{name}

cURL

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

200

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

Required scope: read

Path parameters

name · string · required

Predicate name

Response

PredicateResponse

arg_types · string[] · required

arity · integer · required

doc · string

name · string · required

return_type · string

Status codes

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

cURL

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

200

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