Batch create entities

Batch create entities. Required scope: write

POST /api/v1/entities/batch

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/entities/batch' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "entities": [
    {
      "entity_type": "string",
      "name": "Two-Person Tent",
      "properties": {}
    }
  ]
}'

200

{
  "created": 1,
  "entities": [
    {
      "confidence": 7.5,
      "created_at": "2026-08-31T14:22:05Z",
      "entity_type": "string",
      "has_embedding": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "properties": {},
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "errors": [
    "string"
  ],
  "failed": 1
}

Batch create entities.

Required scope: write

Request body

BatchCreateEntitiesRequest

entities · CreateEntityRequest[] · required

Response

BatchCreateEntitiesResponse

created · integer · required

entities · EntityResponse[] · required

Show EntityResponse

confidence · number (float) · required

Confidence score

created_at · string

Creation timestamp (RFC3339)

entity_type · string · required

Entity type

has_embedding · boolean · required

Whether entity has an embedding vector

id · string · required

Unique entity ID

name · string · required

Entity name

properties · object · required

Entity properties

updated_at · string

Last update timestamp (RFC3339)

errors · string[] · required

failed · integer · required

Status codes

Code	Meaning
200	Per-item results; failures reported individually
400	Batch exceeds max_batch_size
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/entities/batch' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "entities": [
    {
      "entity_type": "string",
      "name": "Two-Person Tent",
      "properties": {}
    }
  ]
}'

200

{
  "created": 1,
  "entities": [
    {
      "confidence": 7.5,
      "created_at": "2026-08-31T14:22:05Z",
      "entity_type": "string",
      "has_embedding": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "properties": {},
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "errors": [
    "string"
  ],
  "failed": 1
}