Skip to content
Qualia Docs

Begin a dataset upload

POST
/v1/datasets/upload/begin
 
curl --request POST \
  --url https://example.com/v1/datasets/upload/begin \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "merge_target": "example", "merge_intent_action_needed": "example", "source_format": "example", "upload_protocol": 1, "ingest_toml": "example", "rig": "example" }'

Get-or-create the customer’s repo for name (under their own org) and return its handle PLUS its current file tree (prior versions) in one round-trip — the SDK uses the tree for the warm/edit fast paths. Idempotent.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
UploadBeginBody
object
name
required
string
merge_target
string | null
merge_intent_action_needed
string | null
<= 2048 characters
source_format
string | null
upload_protocol
integer
default: 1
ingest_toml
string | null
>= 1 characters <= 65536 characters
rig
string | null
>= 1 characters <= 256 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"
}

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