Skip to content
Qualia Docs

Pin a dataset version — freeze the def's query result

POST
/v1/datasets/versions
 
curl --request POST \
  --url https://example.com/v1/datasets/versions \
  --header 'Content-Type: application/json' \
  --data '{ "def_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "note": "" }'

Resolves the def’s query NOW: frozen episode membership + blake3 membership/norm-stats hashes + the source repos’ commit ids. A training run pointed at the returned version id is reproducible.

Membership is whatever the query selects — quality never narrows it, so a flagged episode the author picked is in the pin.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

Header Parameters

Section titled “Header Parameters ”
x-api-key
string | null

Request Body required

Section titled “Request Body required ”
Media type application/json
PinVersionBody

Freeze a definition’s current result as its next immutable version.

There is deliberately no quality filter here. A pin freezes what the query selects, so it can never quietly drop episodes the author picked; dropping flagged work is curation’s job, which mints its own version from a sealed analysis. Closed to extras, so a client still sending the retired exclude_flagged is refused rather than silently pinning everything under a name that promises otherwise.

object
def_id
required
string format: uuid
note
string
"" <= 4096 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
example

401

Section titled “401 ”

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

404

Section titled “404 ”

No such dataset def

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}