Skip to content

Prepare one complete, format-aware dataset tree

POST
/v1/datasets/upload/prepare
curl --request POST \
--url https://example.com/v1/datasets/upload/prepare \
--header 'Content-Type: application/json' \
--data '{ "repo_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source_format": "lerobot_v2_1", "expected": { "generation": 1, "git_hash_algorithm": "sha1", "git_oid": "example", "commit_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "pack_digest": "example" }, "entries": [ { "path": "example", "manifest_id": "example", "mode": 33188 } ] }'

Validate and stage all trusted artifacts before the sole visibility call.

x-api-key
string | null
Media type application/json
PrepareDatasetPublicationBody
object
repo_id
required
string format: uuid
name
required
string
operation_id
required
string format: uuid
source_format
required
string
Allowed values: lerobot_v2_1 lerobot_v3 mcap_ros2
expected
object
generation
required
integer
> 0
git_hash_algorithm
required
string
Allowed values: sha1 sha256
git_oid
required
string
/^(?:[0-9a-f]{40}|[0-9a-f]{64})$/
commit_id
required
string format: uuid
pack_digest
required
string
/^[0-9a-f]{64}$/
entries
required
Array<object>
>= 1 items
PublicationEntry
object
path
required
string
manifest_id
required
string
/^[0-9a-f]{64}$/
mode
integer
default: 33188

Successful Response

Media type application/json
Example generated
example

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