Skip to content

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 ​

POSThttps://transkribus.eu/TrpServer/rest/LA/analyze

Parameters​

Query Parameters

collId
Type
integer
Format
"int32"
doBlockSeg
Type
boolean
Default
false
doLineSeg
Type
boolean
Default
true
doWordSeg
Type
boolean
Default
false
doPolygonToBaseline
Type
boolean
Default
false
doBaselineToPolygon
Type
boolean
Default
false
jobImpl
Type
string
Default
"TranskribusLaJob"
credits
Type
string
Default
"AUTO"

Request Body​

Format"int32"

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value
Body

Samples​

POST /LA/la2Inference ​

POSThttps://transkribus.eu/TrpServer/rest/LA/la2Inference

Parameters​

Query Parameters

collId
Type
integer
Format
"int32"
modelId
Type
integer
Format
"int32"
threshold
Type
number
Format
"double"
Default
0.75
addToPageXML
Type
boolean
Default
false
approxPolyFrac
Type
number
Format
"double"
Default
0.7
combineWithBaseLayout
Type
boolean
Default
false
keepEmptyRegions
Type
boolean
Default
false
splitLines
Type
boolean
Default
false
lineOverlapFraction
Type
number
Format
"double"
Default
0.05
clusterLinesWithoutRegions
Type
boolean
Default
false
credits
Type
string
Default
"AUTO"

Request Body​

Format"int32"

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value
Body

Samples​

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 ​

POSThttps://transkribus.eu/TrpServer/rest/LA/tableInference

Parameters​

Query Parameters

collId
Type
integer
Format
"int32"
modelId
Type
integer
Format
"int32"
credits
Type
string
Default
"AUTO"

Request Body​

Format"int32"

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Jobs ​

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} ​

GEThttps://transkribus.eu/TrpServer/rest/jobs/{id}

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

GET /jobs/list ​

GEThttps://transkribus.eu/TrpServer/rest/jobs/list

Parameters​

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
0
nValues
Type
integer
Format
"int32"
Default
50
sortColumn
Type
string
sortDirection
Type
string

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

POST /jobs/{id}/kill ​

POSThttps://transkribus.eu/TrpServer/rest/jobs/{id}/kill

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

default response

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Transkribus Developer Platform