Skip to content

Collections ​

A collection is a folder of documents that share members, roles and settings. Every account starts with a personal collection; institutions organise their material by project or holding, one collection each. A collection has a numeric id, collId, that every document operation needs.

Authentication is the same as for every other API: a Transkribus account and a Bearer token, see Authentication. The operations below are the Transkribus REST API, the same server behind the Transkribus app; its document is in the API Reference.

Your collections ​

Lists the collections you own or that are shared with you, with your role in each. Filter and page with the query parameters.

GET /collections ​

GEThttps://transkribus.eu/TrpServer/rest/collections

Parameters​

Query Parameters

index
Type
integer
Format
"int32"
Default
0
nValues
Type
integer
Format
"int32"
Default
0
sortColumn
Type
string
sortDirection
Type
string
excludeEmpty
Type
boolean
Default
false
filter
Type
string
role
Type
array
userid
Type
integer
Format
"int32"
favorites
Type
boolean
collId
Type
array

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

The documents in a collection ​

Each entry carries the document id, docId, used by Documents.

GET /collections/{collId}/list ​

GEThttps://transkribus.eu/TrpServer/rest/collections/{collId}/list

Parameters​

Path Parameters

collId*
Type
integer
Required
Format
"int32"

Query Parameters

uploaderId
Type
integer
Format
"int32"
uploader
Type
string
labelId
Type
array
title
Type
string
author
Type
string
writer
Type
string
description
Type
string
genre
Type
string
language
Type
string
hierarchy
Type
string
authority
Type
string
extId
Type
string
scriptType
Type
string
createdfrom
Type
integer
Format
"int64"
createdto
Type
integer
Format
"int64"
ultimestamp
Type
integer
Format
"int64"
includeNulls
Type
boolean
isDeleted
Type
string
Default
"false"
index
Type
integer
Format
"int32"
Default
0
nValues
Type
integer
Format
"int32"
Default
0
sortColumn
Type
string
sortDirection
Type
string
pagingWrapper
Type
boolean
Default
false

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Collection metadata ​

GET /collections/{collId}/metadata ​

GEThttps://transkribus.eu/TrpServer/rest/collections/{collId}/metadata

Parameters​

Path Parameters

collId*
Type
integer
Required
Format
"int32"

Query Parameters

stats
Type
boolean
Default
false

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Find documents across collections ​

GET /collections/findDocuments ​

GEThttps://transkribus.eu/TrpServer/rest/collections/findDocuments

Parameters​

Query Parameters

collId
Type
array
title
Type
string
descr
Type
string
author
Type
string
writer
Type
string
id
Type
integer
Format
"int32"
userid
Type
integer
Format
"int32"
labelId
Type
array
uploaderId
Type
integer
Format
"int32"
uploader
Type
string
genre
Type
string
language
Type
string
hierarchy
Type
string
authority
Type
string
extId
Type
string
scriptType
Type
string
createdfrom
Type
integer
Format
"int64"
createdto
Type
integer
Format
"int64"
ultimestamp
Type
integer
Format
"int64"
includeNulls
Type
boolean
isDeleted
Type
boolean
Default
false
exactMatch
Type
boolean
Default
true
caseSensitive
Type
boolean
Default
false
index
Type
integer
Format
"int32"
Default
0
nValues
Type
integer
Format
"int32"
Default
100
sortColumn
Type
string
sortDirection
Type
string
pagingWrapper
Type
boolean
Default
false

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Creating, renaming and sharing collections, inviting members and setting roles are done in the Transkribus app today (help center); those operations are not yet on the platform.

Transkribus Developer Platform