Skip to content

List items in a version (filterable by split) ​

GEThttps://api-dataset.transkribus.org/v1/datasets/{id}/versions/{vid}/items

Returns the items linked to a version. Requires read access to the
dataset (owner, admin, an explicit access grant, or a public dataset).

This response is paginated and limit defaults to 100. Items come
back ordered by row id, and whether a given split appears in the first
page depends on the order the items happened to be inserted — a version
with thousands of validation items can answer an unpaginated request
with train items only. Always compare data.length against total,
and page until you have total rows. To ask about one split, filter
with split= rather than scanning an unfiltered page: total is then
the exact count for that split. GET .../versions/{vid}/splits returns
per-split counts directly and is not subject to pagination at all.

Parameters​

Path Parameters

id*

Dataset (definition) ID

Type
integer
Required
vid*

Version ID (must belong to the dataset given in id)

Type
integer
Required

Query Parameters

split

Optional split filter

Type
string
Valid values
"train""validation""test"
limit

Max number of items to return. Defaults to 100 when omitted — pass
an explicit value to get more. 0 is treated as omitted (falls back
to 100) and negative values are rejected by the database, so page
with a real page size instead of trying to disable the limit.

Type
integer
Default
100
offset

Number of items to skip (pagination)

Type
integer
Default
0

Responses​

Items retrieved successfully

application/json

Total number of matching items (ignores limit/offset)

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Transkribus Developer Platform