Skip to content

Projects ​

A project bundles collections, models, datasets, sites and people for one research context, so several bodies of work stay separated. The Projects API creates projects, manages members and their roles, attaches resources, handles join requests, and runs tasks and pipelines on a project's material.

Authentication is the same as for every other API: a Transkribus account and a Bearer token, see Authentication. The operations a first integration needs are on this page; every other operation is in the groups beneath this page in the sidebar.

How a project is organised ​

ObjectWhat it is
ProjectName, description, visibility (private, organisation or public) and join mode. Public and organisation projects can be discovered and joined.
MembersUsers with a role in the project. Ownership can be transferred.
ResourcesThe collections, models, datasets and sites attached to the project.
Join requestsRequests to join a project that requires approval; owners approve or decline them.
Tasks and pipelinesWork units on the project's material, with a board view and per-step state.

Working with a project ​

List your projects and create one.

List all accessible projects ​

GEThttps://projects-api.transkribus.org/v1/projects

Parameters​

Query Parameters

page
Type
integer
Minimum
1
Default
1
limit
Type
integer
Minimum
1
Maximum
100
Default
10
status
Type
string
Valid values
"active""archived""deleted"
Default
"active"
search
Type
string
Max Length
255

Responses​

List of projects

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Create a new project ​

POSThttps://projects-api.transkribus.org/v1/projects

Request Body​

application/json
Max Length255
Max Length2000

Project visibility. Organisation visibility requires the owner to belong to an organisation.

Valid values"private""public""organisation"
Default"private"

URL to project image

Format"uri"

Country related to the documents

City related to the documents

Start year of time period

Minimum0
Maximum9999

End year of time period

Minimum0
Maximum9999

Languages used in documents

Institution or archive name

Type of documents (e.g., letters, ledgers)

Optional array of collection IDs to link to this project

Optional array of site IDs to link to this project

Optional array of model IDs to link to this project

Responses​

Project created successfully

Try it out

Playground​

Authorization
Body

Samples​

Read a project and its members.

Get a specific project ​

GEThttps://projects-api.transkribus.org/v1/projects/{id}

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses​

Project details with linked collections, sites, and models

application/json
Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Get project members ​

GEThttps://projects-api.transkribus.org/v1/projects/{id}/members

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses​

List of project members

Try it out

Playground​

Authorization
Variables
Key
Value

Samples​

Attach a collection.

Add collections to a project ​

POSThttps://projects-api.transkribus.org/v1/projects/{id}/collections

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Request Body​

application/json

Array of collection IDs from Transkribus API

Min Items1

Responses​

Collections added successfully

Try it out

Playground​

Authorization
Variables
Key
Value
Body

Samples​

What the reference leaves out ​

The admin review queue and the health endpoints are not part of the developer platform and are left out of the sidebar.

Transkribus Developer Platform