Appearance
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
| Object | What it is |
|---|---|
| Project | Name, description, visibility (private, organisation or public) and join mode. Public and organisation projects can be discovered and joined. |
| Members | Users with a role in the project. Ownership can be transferred. |
| Resources | The collections, models, datasets and sites attached to the project. |
| Join requests | Requests to join a project that requires approval; owners approve or decline them. |
| Tasks and pipelines | Work 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
GET
https://projects-api.transkribus.org/v1/projectsCreate a new project
POST
https://projects-api.transkribus.org/v1/projectsRequest Body
application/json
Max Length
255Max Length
2000Project 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
Minimum
0Maximum
9999End year of time period
Minimum
0Maximum
9999Languages 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
Read a project and its members.
Get a specific project
GET
https://projects-api.transkribus.org/v1/projects/{id}Get project members
GET
https://projects-api.transkribus.org/v1/projects/{id}/membersAttach a collection.
Add collections to a project
POST
https://projects-api.transkribus.org/v1/projects/{id}/collectionsWhat 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.