Skip to content
Qualia Docs

Preview one file in a dataset repo

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

Format-aware single-file preview: inline text for small text files, parquet schema + sample rows, tensor tables for model formats, plain metadata otherwise.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
path
required

Dataset path (org/name)

string
<= 300 characters

Dataset path (org/name)

file
required

File path within the repo

string
<= 500 characters

File path within the repo

ref

Branch / tag / commit (default main)

string | null
<= 120 characters

Branch / tag / commit (default main)

Header Parameters

Section titled “Header Parameters ”
x-api-key
string | null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Text content / parquet rows / tensor table / metadata

Media type application/json
Example generated
example

404

Section titled “404 ”

Unknown file, ref, or non-QDS backend

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