List a dataset's files

POST

/v1/datasets/download/begin

curl --request POST \
  --url https://example.com/v1/datasets/download/begin \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "commit_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "snapshot_digest": "example", "after_path": "example", "limit": 128 }'

Return one bounded page from an immutable paired Git snapshot.

Authorizations

• ApiKey
• Bearer

Request Body ^required

Media type application/json

DownloadBeginBody

object

name

required

string

commit_id

string | null format: uuid

snapshot_digest

string | null

/^[0-9a-f]{64}$/

after_path

string | null

>= 1 characters <= 4096 characters

limit

integer

default: 128 >= 1 <= 4096

Responses

200

Successful Response

Media type application/json

Example ^generated

example

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

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