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' \
  --data '{ "name": "example", "source_format": "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.

Parameters

Header Parameters

x-api-key

string | null

Request Body ^required

Media type application/json

UploadBeginBody

object

name

required

string

source_format

string | null

Example ^generated

{
  "name": "example",
  "source_format": "example"
}

Responses

200

Successful Response

Media type application/json

Example ^generated

example

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