Add multiple symbols at once

Efficiently add multiple symbols to the vocabulary in a single request. This is more efficient than making individual requests for each symbol…

POST /api/v1/nsr/symbols/batch

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/nsr/symbols/batch' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "names": [
    "WALK",
    "RUN",
    "JUMP",
    "TURN_LEFT",
    "TURN_RIGHT"
  ]
}'

200

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

Efficiently add multiple symbols to the vocabulary in a single request. This is more efficient than making individual requests for each symbol. Example

curl -X POST 'https://api.nsr.stateset.com/api/v1/nsr/symbols/batch' \
-H 'X-API-Key: your-api-key' \
-H 'Content-Type: application/json' \
-d '{'names': ['WALK', 'RUN', 'JUMP', 'TURN_LEFT', 'TURN_RIGHT']}'

Required scope: write

Request body

AddSymbolsRequest

names · string[] · required

List of symbol names

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	Symbols added successfully
400	Invalid request - empty list or too many symbols
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/nsr/symbols/batch' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "names": [
    "WALK",
    "RUN",
    "JUMP",
    "TURN_LEFT",
    "TURN_RIGHT"
  ]
}'

200

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