Transkribus Developer Platform

Appearance

Your first job ​

Three requests: submit an image, poll the job, download the result. Get an access token first. See Authentication.

1. Submit an image ​

Send the image (base64 or URL) with the ID of the text recognition model to apply. The response contains a processId.

bash
curl -X POST https://api-staging.transkribus.org/v2/processes \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "config": { "textRecognition": { "htrId": 38230 } },
    "image": { "imageUrl": "https://example.org/scan.jpg" }
  }'

2. Poll the job ​

Poll until the status is FINISHED (see How jobs work for all statuses and the longpoll alternative).

bash
curl https://api-staging.transkribus.org/v2/processes/$PROCESS_ID \
  -H "Authorization: Bearer $ACCESS_TOKEN"

3. Download the result ​

Follow the result link for a ZIP archive, or the page-result link for PAGE XML. Results are retained for 24 hours after completion.

bash
curl -o result.zip https://api-staging.transkribus.org/v2/processes/$PROCESS_ID/result \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Transkribus Developer Platform