List all symbols in the vocabulary

Returns all symbols currently in the NSR Machine’s vocabulary, including their IDs, names, and whether they have associated programs…

GET /api/v1/nsr/symbols

cURL

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

200

{
  "symbols": [
    {
      "has_program": true,
      "id": 1001,
      "name": "Two-Person Tent"
    }
  ],
  "total": 102
}

Returns all symbols currently in the NSR Machine’s vocabulary, including their IDs, names, and whether they have associated programs. Example

curl -X GET 'https://api.nsr.stateset.com/api/v1/nsr/symbols' \
-H 'X-API-Key: your-api-key'

Required scope: read

Response

ListSymbolsResponse

symbols · SymbolResponse[] · required

List of symbols

Show SymbolResponse

has_program · boolean · required

Whether the symbol has an associated program

id · integer (int64) · required

Symbol ID

name · string · required

Symbol name

total · integer · required

Total count

Status codes

Code	Meaning
200	List of all symbols in vocabulary
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/nsr/symbols' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "symbols": [
    {
      "has_program": true,
      "id": 1001,
      "name": "Two-Person Tent"
    }
  ],
  "total": 102
}