Appearance
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
GET
https://transkribus.eu/TrpServer/rest/collectionsParameters
Query Parameters
index
Type
integer
Format
"int32"Default
0nValues
Type
integer
Format
"int32"Default
0sortColumn
Type
string
sortDirection
Type
string
excludeEmpty
Type
boolean
Default
falsefilter
Type
string
role
Type
array
userid
Type
integer
Format
"int32"favorites
Type
boolean
collId
Type
array
Responses
default response
The documents in a collection
Each entry carries the document id, docId, used by Documents.
GET /collections/{collId}/list
GET
https://transkribus.eu/TrpServer/rest/collections/{collId}/listParameters
Path Parameters
collId*
Type
Requiredinteger
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
0nValues
Type
integer
Format
"int32"Default
0sortColumn
Type
string
sortDirection
Type
string
pagingWrapper
Type
boolean
Default
falseResponses
default response
Collection metadata
GET /collections/{collId}/metadata
GET
https://transkribus.eu/TrpServer/rest/collections/{collId}/metadataFind documents across collections
GET /collections/findDocuments
GET
https://transkribus.eu/TrpServer/rest/collections/findDocumentsParameters
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
falseexactMatch
Type
boolean
Default
truecaseSensitive
Type
boolean
Default
falseindex
Type
integer
Format
"int32"Default
0nValues
Type
integer
Format
"int32"Default
100sortColumn
Type
string
sortDirection
Type
string
pagingWrapper
Type
boolean
Default
falseResponses
default response
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.