StateSet API Docs

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

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 '&#123;'names': ['WALK', 'RUN', 'JUMP', 'TURN_LEFT', 'TURN_RIGHT']&#125;'

Required scope: write

Request body

AddSymbolsRequest

string[]

required

List of symbol names

Response

ListSymbolsResponse

SymbolResponse[]

required

List of symbols

Show SymbolResponse

boolean

required

Whether the symbol has an associated program

integer (int64)

required

Symbol ID

string

required

Symbol name

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 --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/nsr/symbols/batch' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "names": [
    "WALK",
    "RUN",
    "JUMP",
    "TURN_LEFT",
    "TURN_RIGHT"
  ]
}'

{
  "symbols": [
    {
      "has_program": true,
      "id": 1,
      "name": "string"
    }
  ],
  "total": 1
}

​Request body

​Response

​Status codes

Request body

Response

Status codes