Preview artifact content

Return a structured preview of an artifact’s content. Supports CSV, TSV, plain text, SQL, markdown, HTML, XML, YAML, JSON, and JSONL.

GET /assets/artifacts/{resource_uri}/preview

Preview artifact content

cURL

curl --request GET \
  --url https://api.example.com/assets/artifacts/{resource_uri}/preview \
  --header 'Authorization: Bearer <token>'

200

{
  "resource_uri": "<string>",
  "content_type": "<string>",
  "truncated": true,
  "columns": [
    "<string>"
  ],
  "rows": [
    [
      "<unknown>"
    ]
  ],
  "size_bytes": 123,
  "meta": {},
  "preview_type": "tabular"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Project-ID · string | null

Path Parameters

resource_uri · string · required

Artifact resource URI (e.g., 'artifact:acme-corp:ml-project:training-dataset')

Query Parameters

limit · integer · default: 500

Number of rows (tabular) or lines (text) to return

Required range: 1 <= x <= 10000

max_bytes · integer · default: 524288

Maximum bytes to read from storage

Required range: 1 <= x <= 1048576

Response

200

application/json

Successful Response

TabularPreview

TextPreview

RawPreview

Preview for tabular data (CSV, TSV, Parquet).

resource_uri · string · required

content_type · string · required

truncated · boolean · required

columns · string[] · required

rows · any[][] · required

size_bytes · integer | null

meta · Meta · object

preview_type · string · default: tabular

Allowed value: "tabular"