Skip to content

Search ​

Full-text search looks for terms in the latest transcription of every page in the collections you can access, and returns the pages that contain them with a line preview. Keyword search finds spellings that are close to the term, for handwriting where the recognised text is uncertain.

Operators: AND to require several terms, quotation marks for an exact phrase, ? for a single unknown character, * for several. Results can be narrowed by collection, title, author or uploader.

Authentication is the same as for every other API: a Transkribus account and a Bearer token, see Authentication.

GET /search/fulltext ​

GEThttps://transkribus.eu/TrpServer/rest/search/fulltext

Parameters​

Query Parameters

query
Type
string
type
Type
string
start
Type
integer
Format
"int32"
Default
0
rows
Type
integer
Format
"int32"
Default
10
filter
Type
array
legacy
Type
boolean
Default
false

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

GET /search/keyword ​

GEThttps://transkribus.eu/TrpServer/rest/search/keyword

Parameters​

Query Parameters

query
Type
string
start
Type
integer
Format
"int32"
Default
0
rows
Type
integer
Format
"int32"
Default
10
probL
Type
number
Format
"float"
probH
Type
number
Format
"float"
filter
Type
array
fuzzy
Type
integer
Format
"int32"
sorting
Type
string

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Searching a published site's documents is a separate operation of the Sites API.

Transkribus Developer Platform