Skip to content
Qualia Docs

Publish selected recommendations as a new immutable DatasetVersion

POST
/v1/datasets/curation/apply
 
curl --request POST \
  --url https://example.com/v1/datasets/curation/apply \
  --header 'Content-Type: application/json' \
  --data '{ "idempotency_key": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "analysis_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "selection_digest": "example", "audit_repo_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expected": { "generation": 1, "git_hash_algorithm": "sha1", "git_oid": "example", "commit_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "pack_digest": "example" }, "definition_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "", "description": "", "note": "" }'

Create/recover one fenced DatasetVersion plus canonical Git audit receipt.

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
ApplyDatasetCurationBody
object
idempotency_key
required
string format: uuid
analysis_id
required
string format: uuid
selection_digest
required
string
/^[0-9a-f]{64}$/
audit_repo_id
required
string format: uuid
expected
required
PublicationExpectedHeadModel

Exact paired Git/lakehouse head used as a mutation fence.

object
generation
required
integer
> 0
git_hash_algorithm
required
string
Allowed values: sha1 sha256
git_oid
required
string
/^[0-9a-f]+$/
commit_id
required
string format: uuid
pack_digest
required
string
/^[0-9a-f]{64}$/
definition_id
string | null format: uuid
name
string
"" /^(?:[A-Za-z0-9][A-Za-z0-9._-]{0,127})?$/
description
string
"" <= 4096 characters
note
string
"" <= 4096 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
DatasetCurationReceiptModel
object
idempotency_key
required
string format: uuid
definition_id
required
string format: uuid
version_id
required
string format: uuid
version
required
integer
> 0
included_episode_count
required
integer
> 0 <= 100000
excluded_episode_count
required
integer
<= 100000
evidence_digest
required
string
/^[0-9a-f]{64}$/
audit_repo_id
required
string format: uuid
audit_path
required
string
>= 1 characters <= 4096 characters
audit_manifest_id
required
string
/^[0-9a-f]{64}$/
git_generation
required
integer
> 0
git_commit_id
required
string format: uuid
git_hash_algorithm
required
string
Allowed values: sha1 sha256
git_oid
required
string
/^[0-9a-f]+$/
git_snapshot_digest
required
string
/^[0-9a-f]{64}$/
dataset_snapshot_id
required
string
/^[0-9a-f]{64}$/
membership_hash
required
string
/^[0-9a-f]{64}$/
norm_stats_hash
required
string
/^[0-9a-f]{64}$/
Example 
{
  "git_hash_algorithm": "sha1"
}

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": {}
    }
  ]
}