Transkribus Developer Platform

Appearance

Authentication ​

The Transkribus API uses the OpenID Connect protocol. Authenticate with your Transkribus account credentials (Scholar plan or above) to obtain an access token, and send it as a Bearer token in every API request.

OpenID Connect configuration: https://account.readcoop.eu/auth/realms/readcoop/.well-known/openid-configuration

Replace $USERNAME and $PASSWORD with your Transkribus credentials. The client_id is processing-api-client.

1. Get an access token ​

bash
curl -X POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode grant_type=password \
  --data-urlencode client_id=processing-api-client \
  --data-urlencode username=$USERNAME \
  --data-urlencode password=$PASSWORD

Use the access_token from the response as the Bearer token in subsequent requests.

2. Refresh the access token ​

bash
curl -X POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode grant_type=refresh_token \
  --data-urlencode client_id=processing-api-client \
  --data-urlencode refresh_token=$REFRESH_TOKEN

3. End the session ​

bash
curl -X POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/logout \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode client_id=processing-api-client \
  --data-urlencode refresh_token=$REFRESH_TOKEN

Transkribus Developer Platform