Appearance
Analyse documents
Layout analysis and table recognition run on documents stored in Transkribus. Each call starts a job on the pages you name; the job id comes back at once and the result lands in the document when the job is finished.
Text recognition is different: on the platform it is the Transkribus API, one image per request. The stored-document recognition calls of the REST API are being retired and are not listed here.
Authentication is the same as for every other API: a Transkribus account and a Bearer token, see Authentication.
Layout
Layout analysis segments a page into text regions and baselines, the polylines along the bottom of each text line that recognition and manual transcription build on. It runs on its own when you prepare pages for training or deal with complex layouts; text recognition jobs run it implicitly.
POST /LA/analyze
POST
https://transkribus.eu/TrpServer/rest/LA/analyzeParameters
Query Parameters
collId
Type
integer
Format
"int32"doBlockSeg
Type
boolean
Default
falsedoLineSeg
Type
boolean
Default
truedoWordSeg
Type
boolean
Default
falsedoPolygonToBaseline
Type
boolean
Default
falsedoBaselineToPolygon
Type
boolean
Default
falsejobImpl
Type
string
Default
"TranskribusLaJob"credits
Type
string
Default
"AUTO"Request Body
Format
"int32"Responses
default response
POST /LA/la2Inference
POST
https://transkribus.eu/TrpServer/rest/LA/la2InferenceParameters
Query Parameters
collId
Type
integer
Format
"int32"modelId
Type
integer
Format
"int32"threshold
Type
number
Format
"double"Default
0.75addToPageXML
Type
boolean
Default
falseapproxPolyFrac
Type
number
Format
"double"Default
0.7combineWithBaseLayout
Type
boolean
Default
falsekeepEmptyRegions
Type
boolean
Default
falsesplitLines
Type
boolean
Default
falselineOverlapFraction
Type
number
Format
"double"Default
0.05clusterLinesWithoutRegions
Type
boolean
Default
falsecredits
Type
string
Default
"AUTO"Request Body
Format
"int32"Responses
default response
Tables
Table recognition detects table structure on a page and returns cells with their row and column positions, so tabular material comes back as data rather than a flat sequence of lines.
POST /LA/tableInference
POST
https://transkribus.eu/TrpServer/rest/LA/tableInferenceJobs
Every analysis, training and export call returns a job id. Poll the job until its state is finished or failed; a running job can be cancelled.
GET /jobs/{id}
GET
https://transkribus.eu/TrpServer/rest/jobs/{id}GET /jobs/list
GET
https://transkribus.eu/TrpServer/rest/jobs/listParameters
Query Parameters
userid
Type
integer
Format
"int32"filterByUser
Type
boolean
status
Type
string
collId
Type
integer
Format
"int32"id
Type
integer
Format
"int32"type
Type
string
jobImpl
Type
array
index
Type
integer
Format
"int32"Default
0nValues
Type
integer
Format
"int32"Default
50sortColumn
Type
string
sortDirection
Type
string
Responses
default response