StateSet API Docs

curl --request POST \ --url 'https://api.nsr.stateset.com/api/v1/auth/keys' \ --header 'X-API-Key: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "org_id": "string", "rate_limit_per_minute": 1, "scopes": [ "read" ] }'

{ "created_at": "string", "expires_at": "string", "id": "string", "key": "string", "name": "string", "org_id": "string", "prefix": "string", "rate_limit_per_minute": 1, "scopes": [ "read" ] }

Required scope: admin

Request body

ApiKeyCreateRequest

string

required

Friendly name for the key.

string

Optional org id. Must match the authenticated org when provided.

integer (int32)

Optional rate limit override for this key. · 0 disables rate limiting for this key. · positive values cap requests per minute. · values that are not positive are treated as unset.

ApiScope[]

Scopes for the key (defaults to admin).

Response

ApiKeyCreateResponse

string

required

string

required

string

required

string

required

string

required

string

required

integer (int32)

ApiScope[]

required

Status codes

Code	Meaning
`201`	API key created
`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/auth/keys' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "org_id": "string",
  "rate_limit_per_minute": 1,
  "scopes": [
    "read"
  ]
}'

{
  "created_at": "string",
  "expires_at": "string",
  "id": "string",
  "key": "string",
  "name": "string",
  "org_id": "string",
  "prefix": "string",
  "rate_limit_per_minute": 1,
  "scopes": [
    "read"
  ]
}

​Request body

​Response

​Status codes

Request body

Response

Status codes