Transkribus

https://help.transkribus.org/
Admin
Transkribus is a comprehensive platform for transcribing, searching, and managing historical...
Tokens:39,741
Snippets:675
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Authorize API Requests with Access Token

Source: https://help.transkribus.org/transkribus-legacy-api

To authorize requests to the Transkribus API, include the access token in the 'Authorization' header as a Bearer token. This example shows how to list collections.

```bash
curl -H "Authorization: Bearer $ACCESS_TOKEN" https://transkribus.eu/TrpServer/rest/collections
```

--------------------------------

### List Accessible Collections

Source: https://help.transkribus.org/transkribus-legacy-api

This GET request retrieves a list of all collections accessible to the authenticated user, including their IDs and names.

```http
GET https://transkribus.eu/TrpServer/rest/collections
```

--------------------------------

### Drawing Table Columns

Source: https://help.transkribus.org/tables?hsLang=en

To create columns, select the table and hold V while moving the cursor across the page and clicking wherever you want to create a column.

```text
Select table, hold V, click to create column.
```

--------------------------------

### Obtain Access Token using cURL

Source: https://help.transkribus.org/transkribus-legacy-api

Use this cURL command to authenticate with the Transkribus API and obtain an access token. Replace $USERNAME and $PASSWORD with your actual credentials.

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

--------------------------------

### Check Status of a Specific Job

Source: https://help.transkribus.org/transkribus-legacy-api

Get the current status and details of a specific processing job by providing its job ID.

```http
GET https://transkribus.eu/TrpServer/rest/jobs/{job-ID}
```

--------------------------------

### Obtain Access Token

Source: https://help.transkribus.org/transkribus-legacy-api

Use this cURL command to authenticate and obtain an access token using your username and password. The response includes an access token and a refresh token.

```APIDOC
## Obtain Access Token

### Description
Authenticates with the Transkribus API using username and password to obtain an access token and a refresh token.

### Method
POST

### Endpoint
https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token

### Parameters
#### Request Body
- **grant_type** (string) - Required - Must be `password`.
- **username** (string) - Required - Your Transkribus username.
- **password** (string) - Required - Your Transkribus password.
- **client_id** (string) - Required - Must be `transkribus-api-client`.

### Request Example
```bash
curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode grant_type=password \
--data-urlencode username=$USERNAME \
--data-urlencode password=$PASSWORD \
--data-urlencode client_id=transkribus-api-client
```
```

--------------------------------

### Drawing Table Rows

Source: https://help.transkribus.org/tables?hsLang=en

To create rows, select the table and hold H while moving the cursor across the page and clicking wherever you want to create a row. Keep going until all the cells are marked.

```text
Select table, hold H, click to create row.
```

--------------------------------

### Copying Table Structure Between Pages

Source: https://help.transkribus.org/tables?hsLang=en

If the table layout of several pages is similar, you can copy and paste the table structure from one page to others. Select the table, press CTRL+C, navigate to the next page, and press CTRL+V. Remember to adjust the table to fit the image.

```text
Select table, press CTRL+C, navigate to next page, press CTRL+V.
```

--------------------------------

### Retrieve a Complete Document

Source: https://help.transkribus.org/transkribus-legacy-api

Fetch the full content of a document, including all its pages, by specifying the collection ID and document ID.

```http
GET https://transkribus.eu/TrpServer/rest/collections/{collection-ID}/{document-ID}/fulldoc
```

--------------------------------

### Refresh Access Token using cURL

Source: https://help.transkribus.org/transkribus-legacy-api

If your access token expires, use this cURL command with your refresh token to obtain a new one. Replace $REFRESH_TOKEN with your actual refresh token.

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

--------------------------------

### List Collections

Source: https://help.transkribus.org/transkribus-legacy-api

Retrieves a list of all collections accessible to the authenticated user. The response includes collection IDs, names, and user roles.

```APIDOC
## List Collections

### Description
Retrieves a list of collections accessible to the authenticated user.

### Method
GET

### Endpoint
https://transkribus.eu/TrpServer/rest/collections

### Request Example
```bash
curl -H "Authorization: Bearer $ACCESS_TOKEN" https://transkribus.eu/TrpServer/rest/collections
```

### Response
#### Success Response (200)
Returns a list of collections, each containing:
- **id** (string) - The unique identifier for the collection.
- **name** (string) - The name of the collection.
- **userRole** (string) - The role of the user within the collection.
```
Tokens:
Raw