Skip to main content
POST
Refine a dataset by what each person wrote

Authorizations

Authorization
string
header
required

A SuperX API key ("sxk_..."), created in the SuperX app under Account > API / MCP / CLI. Keys are server-side secrets.

Path Parameters

id
string
required

The dataset id from GET /v1/datasets.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Body

application/json
criterion
string
required

What the rows to match look like, judged on each row's own text, e.g. "supportive or neutral; not mean, sarcastic, or hostile".

Required string length: 3 - 500
keep_matching
boolean
default:true

true keeps the rows that MATCH the criterion; false keeps the rows that do NOT.

sort_by
enum<string>
default:none

Sort the kept rows descending before the limit is applied.

Available options:
followers,
likes,
none
limit
integer

Keep at most this many rows after filtering and sorting.

Required range: 1 <= x <= 1000
title
string

Title for the new dataset. A sensible one is generated when omitted.

Maximum string length: 120
account_id
string

Which of your accounts to refine as. Omit for the main account.

Response

The refinement finished inside the request. data is null when nothing was kept, with a note explaining why.

data
object | null
meta
object

Counts for the refinement. On a 202 only the source id and row count are known.

note
string