Appearance
API Reference
Every operation of the three APIs, rendered from their OpenAPI documents, with request and response schemas and a playground. The operations sit in the sidebar next to the guides that explain them.
| API | Where | Document |
|---|---|---|
| Transkribus API: text recognition jobs on a single image | The six operations are on Recognise text, each in full. | transkribus-api.json |
| Sites API: create and edit sites, search their documents | Sites, then the V2 Sites and Search groups beneath it in the sidebar. | sites-api.json |
| Dataset API: datasets, versions, items, splits and training data | Datasets, then the groups beneath it. | dataset-api.json |
| Projects API: projects, members, resources, join requests, tasks and pipelines | Projects, then the groups beneath it. | projects-api.json |
| Credits API: balances, packages, transactions and costs | Credits API, then the group beneath it. | credits-api.json |
| Transkribus REST API: the server behind the app | Collections, Documents, Analyse documents, Models, Search, each with its operations beneath it. | transkribus-rest.json |
Authentication is the same everywhere: a Bearer token from Authentication. The playground on each operation sends real requests to the host shown above it; paste your token there.