StateSet API Docs

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/entities' \
  --header 'X-API-Key: YOUR_API_KEY'

{
  "items": [
    {
      "confidence": 1,
      "created_at": "string",
      "entity_type": "string",
      "has_embedding": true,
      "id": "string",
      "name": "string",
      "properties": {},
      "updated_at": "string"
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 1,
    "next_cursor": "string",
    "offset": 1,
    "prev_cursor": "string",
    "total": 1
  }
}

GET

api

entities

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/entities' \
  --header 'X-API-Key: YOUR_API_KEY'

{
  "items": [
    {
      "confidence": 1,
      "created_at": "string",
      "entity_type": "string",
      "has_embedding": true,
      "id": "string",
      "name": "string",
      "properties": {},
      "updated_at": "string"
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 1,
    "next_cursor": "string",
    "offset": 1,
    "prev_cursor": "string",
    "total": 1
  }
}

Query Parameters

limit: Maximum number of results (default: 50)
offset: Number of results to skip (default: 0) Response Returns a paginated list of all entities. List entities with pagination.

Required scope: read

Query parameters

integer

Maximum number of items to return (1-1000, default: 50)

integer

Number of items to skip (default: 0)

string

Cursor for cursor-based pagination (alternative to offset)

string

Sort field with optional direction prefix (- for descending) Examples: ‘created_at’, ‘-name’, ‘confidence’

Response

PaginatedEntityResponse

EntityResponse[]

required

The items in this page

Show EntityResponse

number (float)

required

Confidence score

string

Creation timestamp (RFC3339)

string

required

Entity type

boolean

required

Whether entity has an embedding vector

string

required

Unique entity ID

string

required

Entity name

object

required

Entity properties

string

Last update timestamp (RFC3339)

PaginationMeta

required

Show PaginationMeta

boolean

required

Whether there are more items after this page

integer

required

Current page limit

string

Cursor for the next page (if using cursor-based pagination)

integer

required

Current offset

string

Cursor for the previous page

integer

Total number of items (if available)

Status codes

Code	Meaning
`200`	List of entities
`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 GET \
  --url 'https://api.nsr.stateset.com/api/v1/entities' \
  --header 'X-API-Key: YOUR_API_KEY'

{
  "items": [
    {
      "confidence": 1,
      "created_at": "string",
      "entity_type": "string",
      "has_embedding": true,
      "id": "string",
      "name": "string",
      "properties": {},
      "updated_at": "string"
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 1,
    "next_cursor": "string",
    "offset": 1,
    "prev_cursor": "string",
    "total": 1
  }
}

​Query parameters

​Response

​Status codes

Query parameters

Response

Status codes