QDS file tree (+ README) for one dataset

GET

/v1/datasets/files

curl --request GET \
  --url 'https://example.com/v1/datasets/files?path=example'

The repo’s files (path + size) plus a root README.md rendered as the dataset card. Powers the detail page’s Files tab and README-first overview. 404 when the deployment’s data plane isn’t QDS.

Parameters

Query Parameters

path

required

Dataset path (org/name)

string

<= 300 characters

Dataset path (org/name)

ref

Branch / tag / commit (default main)

string | null

<= 120 characters

Branch / tag / commit (default main)

Header Parameters

x-api-key

string | null

Responses

200

File tree + optional rendered README

Media type application/json

Example ^generated

example

404

No QDS files (backend not qds or repo unknown)

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