Skip to main content
POST
/
v1
/
views
/
cluster
Create a cluster view
curl --request POST \
  --url https://api.withsplendor.com/v1/views/cluster \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-splendor-tenant-id: <x-splendor-tenant-id>' \
  --data '
{
  "datasets": [
    "<string>"
  ],
  "seed_queries": [
    "<string>"
  ],
  "k": 2,
  "name": "<string>",
  "tau": 1,
  "time_range": {
    "gt": "2023-11-07T05:31:56Z",
    "gte": "2023-11-07T05:31:56Z",
    "lt": "2023-11-07T05:31:56Z",
    "lte": "2023-11-07T05:31:56Z"
  }
}
'
{
  "created_at": "2026-01-15T09:30:00Z",
  "expires_at": "2026-01-15T09:30:00Z",
  "from_search_id": "srch_8f2c",
  "kind": "materialized",
  "name": "Timeout errors",
  "record_count": 1240,
  "total": {
    "relation": "eq",
    "value": 1240
  },
  "view_id": "view_01H8Z3"
}

Authorizations

​
Authorization
string
header
required

API token issued from the Splendor console.

Headers

​
x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Body

application/json

Freeze a semantic/hybrid cluster (all members with fused score >= tau, up to k) into a materialized view that SQL can aggregate exhaustively.

​
datasets
string[]
required
Minimum array length: 1
​
seed_queries
string[]
required

One or more seed phrasings; their neighborhoods are unioned to widen recall.

Required array length: 1 - 16 elements
​
k
integer | null

Max members; bounded by the server's cluster_view_max_members.

Required range: x >= 1
​
name
string | null
Required string length: 1 - 255
​
tau
number | null

Fused-score threshold; omit to auto-pick from the score-distribution knee.

Required range: x >= 0
​
time_range
TimeRange · object

Response

Successful Response

The response is of type object.