Skip to main content
GET
Preview dataset rows

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

dataset_id
string
required

Dataset ID

Query Parameters

cursor
integer<int64>

Byte-offset cursor from the previous page's next_cursor. Omit for the first page.

Required range: x >= 0
limit
integer<int32>

Rows per page, 1..=100 (default 50).

start_row
integer<int64>

0-based row number to start the page at (jump-to-row). Takes precedence over cursor. The first jump into a dataset builds a sparse row index (one full streaming read); every later jump is two small S3 reads.

Required range: x >= 0
snapshot
string

Stream view: read the dataset AS OF this snapshot (snap-N, N, or the full <id>@snap-N). Supersessions/tombstones up to its head are resolved. Omit for the live head. Switches the response to {row_id, row} objects with next_cursor = the last row_id.

since
integer<int64>

Stream view: only rows with row_id > since (pass the previous page's next_cursor). Implies the stream view even without snapshot.

Response

One page of raw dataset rows

One page of dataset rows. Uploads: rows are the raw JSONL objects and next_cursor is an opaque byte offset into the stored JSONL; pass it back verbatim as cursor to fetch the next page (null after the last row). Stream view (stream datasets, or snapshot/since given): rows are {row_id, row} objects and next_cursor is the last row_id, to pass back as since. total_rows is set for uploads only.

object
string
required
rows
any[]
required
next_cursor
integer<int64> | null
Required range: x >= 0
total_rows
integer<int32> | null