Check if the current Transkribus session is valid.

Get details of the currently authenticated user.

Invalidate the current authentication session.

Log out of the current Transkribus session.

Refresh the current authentication session token.

List all collections accessible to the current user.

Get the total number of collections accessible to the current user.

Count documents matching the given search criteria.

Create a new collection with the given name.

Search for documents across collections using filters.

Search for documents across collections using a POST request body.

Search for documents using the legacy endpoint.

Create documents from an IOB import.

List collections with pagination support.

List all collections in XML format.

Search for collections by name.

Get recently accessed collections.

Get recently accessed documents.

Delete a collection by ID.

Add an existing document to a collection.

Add multiple existing documents to a collection.

Check if the current user can manage the specified collection.

Get the number of documents in a collection.

Create a document in a collection from an IIIF manifest URL.

Create a document in a collection from a METS XML document, uploaded as multipart form data. Provide exactly one of metsXml or metsFilePath.

Create a document in a collection from a METS URL.

Delete a collection only if it is empty.

Duplicate an entire collection.

Duplicate a document within a collection.

Import EAD metadata into a collection.

Export documents from a collection in the specified format.

Ingest a document into a collection from an FTP source.

List all documents in a collection with pagination.

List all documents in a collection in XML format.

Get metadata for a collection.

Update the metadata for a collection.

Remove a collection from the user favorites.

Add a collection to the user favorites.

Get recently accessed items in a collection.

Modify the properties of a collection.

List collections accessible to a specific user.

Remove a document from a collection without deleting it.

Delete a document from a collection.

List all collections a document belongs to.

List all collections a document belongs to with pagination.

Get the processing costs for a document.

Get document statistics summary.

Get the editorial declaration for a document.

Create or update the editorial declaration for a document.

Export a document in the specified format.

Get the transcribed text of a whole document in one call, with "--- page N ---" separators. Fetches at most 100 pages and 100000 characters per call; when more remain, the result carries nextStartPage.

Get the full document including all pages and transcripts.

Get the full document in XML format.

Check if a document has an affiliation.

Get the image file names for all pages in a document.

Search for keywords within a document.

List pages in a document with pagination.

Get metadata for a document.

Update metadata for a document.

Get the METS metadata for a document.

Get the page IDs for all pages in a document.

Get all pages for a document.

Remove a document from a collection without deleting it.

Get detailed statistics for a document.

Get the test set data for a document.

Get the training data for a document.

Get all transcript IDs for a document.

Update a transcript for a specific page in a document.

Get the validation data for a document.

Move pages within a document based on image names.

Update document metadata using the v2 endpoint.

Delete a page from a document.

Get details of a specific page in a document.

Move a page to a different position within the document or to another document.

Add a new page to a document at the specified position.

Get the number of transcripts for a page.

Get the current transcript for a page.

Delete a specific transcript version from a page.

Set whether a page is hidden on public sites.

Check if a page is currently locked.

List all transcript versions for a page.

List all locks on a page.

Lock or unlock a page for editing.

Get metadata for a specific page.

Return the scanned image of a page as an image content block, so a multimodal client can read the manuscript itself. Defaults to the thumbnail and a 5000000-byte cap; ask for size "full" to get the full-resolution scan.

Get the plain text content of a page transcript.

Assign plain text content to a page as a new transcript.

Replace a page image in a document.

Post a new transcript for a page.

Get a specific transcript version for a page.

Update the status of a specific transcript version.

Get the transcript text for a specific page.

Update page status using transcript ID (alternative endpoint).

Add a user to a collection or modify their role if they already exist.

Get the list of users with access to a collection.

Add a new user to a collection with an optional role.

Remove a user from a collection by their user ID.

Update the role of a user in a collection.

List users of a collection with optional pagination.

Get the number of users in a collection.

Get user statistics for a collection.

Remove a user from a collection using the POST endpoint.

Get the crowd project details for a collection.

Create or update the crowd project configuration for a collection.

Delete messages from the crowd project of a collection.

Delete milestones from the crowd project of a collection.

Store a new message in the crowd project of a collection.

Store a new milestone in the crowd project of a collection.

List all editorial declaration features for a collection.

Store a new editorial declaration feature in a collection.

Store a new option for an editorial declaration feature.

Delete an editorial declaration feature from a collection.

Delete an option from an editorial declaration feature.

List credit packages associated with a collection.

Get credit transaction records for a collection.

Get the credit usage history for a collection.

Add a credit package to a collection.

Remove a credit package from a collection.

Get statistics for a collection.

Get storage usage details for a collection.

Get the page status overview for a collection.

Update the status of pages in a collection.

Get collection statistics using the new stats endpoint.

Get collection pages with filtering via POST body.

List all labels associated with a collection.

Get recognition activity records for a collection.

Get save activity records for a collection.

Update the default tag definitions across all collections.

List tag definitions for a collection.

Update tag definitions for a specific collection.

Get the subscription status for a collection.

Retrieve information about available ATR (Automatic Text Recognition) models.

Run Automatic Text Recognition on a document or specific pages.

Compute a recognition sample for a document in a collection.

Compute the Word Error Rate for a document.

Compute the Word Error Rate using TASAS method for a document.

List available dictionaries for recognition.

Get the error rate for a collection or model.

Compute the error rate for a model in a collection.

Start CITlab HTR model training for a collection.

Start Layout Analysis 2 model training for a collection.

Start CITlab Layout Analysis model training for a collection.

List available recognition models with optional filtering.

Run OCR on a document or specific pages in a collection.

Get the estimated OCR costs for a document.

Run CITlab Text2Image alignment for a collection.

Start table recognition model training for a collection.

List recognition models available in a specific collection.

Delete a recognition model from a collection.

Get details of a recognition model in a collection.

Update a recognition model in a collection.

Add a recognition model to another collection.

List collections that have access to a recognition model.

Get the cost information for a recognition model.

Remove a recognition model from a collection.

Get the test set data for a recognition model.

Get the training data for a recognition model.

Get the training set for a recognition model.

Run CITlab HTR recognition on a document using a specific model.

Run Text2Image alignment using a specific model in a collection.

Run Text2Image matching using a specific model in a collection.

Run TRHTR recognition using a specific model in a collection.

Get information about adding a recognition model to collections.

Get validation ground truth data for a recognition model.

Run layout analysis on document pages.

Run advanced layout analysis with additional parameters.

Get the cost estimate for layout analysis on a document.

Run LA2 model inference on document pages.

Run table structure inference on document pages.

Start PyLaia HTR model training for a collection. By default, sends training parameters matching the Transkribus UI defaults (textFeatsCfg with TextFeats preprocessing, use_masked_conv=True, max_epochs=100). Without these defaults, the server uses different preprocessing (trpPreprocPars) which produces significantly worse models. Set noTrainingDefaults=true to send no training parameters (server defaults).

Run PyLaia HTR recognition on a document using a specific model.

Start P2PaLA layout analysis model training for a collection.

Run Document Understanding recognition on a document using a specific model.

Update a model by posting updated model data.

List available models with optional pagination and filtering.

Get details of a model by its ID.

Delete a model by its ID.

List collections associated with a model by its ID.

Add a collection to a model by model ID and collection ID.

Remove a collection from a model by model ID and collection ID.

Get models filtered by type with optional query parameters.

Get detailed information about a model by type and ID.

Update a model by its type and ID.

Delete a model by its type and ID.

List collections associated with a model by type and ID.

Get the field parameters for a model by type and ID.

Get the training data for a model by type and ID.

Get the documents used as training data for a model.

Get statistics about the training data for a model.

Get the validation data for a model by type and ID.

Get the documents used as validation data for a model.

Get statistics about the validation data for a model.

Add a collection to a model by type and model ID.

Remove a collection from a model by type, model ID, and collection ID.

Search across document transcriptions using a fulltext query.

Search for documents matching a keyword.

Search for a term and replace it across documents.

Reset the search index, optionally for a specific collection.

Search for tags, optionally filtered by collection or tag name.

Search for a term and replace it within a specific collection.

List keyword spotting queries.

Create a new keyword spotting query.

Get hits for a keyword spotting query.

Get keywords for a keyword spotting query.

Get result data for a keyword spotting query.

Create a new processing job.

Get the total number of jobs, optionally filtered by status or type.

List jobs with pagination, optionally filtered by status or type.

Restart all jobs for a specific user.

Get details of a specific job by ID.

Update properties of an existing job.

Get error details for a specific job.

Kill a running job by ID.

Undo the results of a completed job.

Poll a job until it reaches FINISHED, FAILED or CANCELED, or until the wait budget runs out. Defaults: poll every 5s, wait up to 30s; a timed-out result is not an error — call again to keep waiting.

Get credit transactions associated with a specific job.

Get the total count of actions, optionally filtered by collection or type.

Retrieve detailed information about a specific action.

List actions with optional filtering by collection, type, and pagination.

Get the total number of documents owned by the current user.

Search for users by username/email.

Check if the current user is allowed to run a specific job type.

Get the job access control list for the current user.

List all users with pagination.

List documents owned by the current user with pagination.

List all tag definitions for the current user.

Get usage statistics for the current user.

Create or update tag definitions for the current user.

Delete a user by ID.

Get details of a specific user by ID.

Initialize or set up a user account by ID.

Get recognition activity history for a specific user.

Get save activity history for a specific user.

Get storage usage information for a specific user.

Get the total count of crowdsourcing projects.

List available crowdsourcing projects.

Get crowdsourcing details for a collection.

Subscribe to a crowdsourcing project for a collection.

Unsubscribe from a crowdsourcing project for a collection.

Get the total count of e-learning courses.

List available e-learning courses.

Subscribe to an e-learning course for a collection.

Unsubscribe from an e-learning course for a collection.

Rebuild the search index for all recognition models.

List all currently active user sessions.

Move a field recognition model to a different directory.

Move a table recognition model to a different directory.

Retrieve the log output for a specific job.

Retrieve administrative reports by type and time period.

Authorize specific users to run a job implementation.

List users authorized to run a specific job implementation.

List credit packages for the current user.

Create a new credit package.

Get the credit cost information, optionally filtered by type.

List credit transactions with pagination.

Get the credit usage history with pagination.

Create or update credit history entries.

Process a credit order by ID.

List available credit products for purchase.

Get details of a specific credit package by ID.

Update an existing credit package by ID.

List collections associated with a specific credit package.

List credit transactions for a specific credit package.

Create an upload from a METS XML document.

Create an upload document structure describing pages to be uploaded.

Retrieve bulk document metadata for uploads.

Bulk update document metadata for uploads from a CSV payload.

Retrieve bulk ISAD(G) metadata for uploads.

Bulk update ISAD(G) metadata for uploads from a CSV payload.

Create an upload from an S3 source.

Get the status of an upload by ID.

Upload a page image (and optional PAGE XML) to an existing upload.

Delete an upload by ID.

Update metadata for an existing upload.

List all labels.

Create a new label.

Get a label by ID.

Update an existing label by ID.

Delete a label by ID.

Assign documents to a label.

Remove documents from a label.

Remove all documents from a label.

Replace label assignments for a specific document.

Assign pages to a label.

Remove pages from a label.

Remove all pages from a label.

Replace label assignments for a specific page.

Check the status or existence of a file at a given path.

List files at a given path on the server.

List directories at a given path on the server.

Check the status of the Transkribus database.

Check the status of the Transkribus image store.

List available client files on the server.

Submit a bug report to the Transkribus server.

Get the current Transkribus client version.

Download a specific client file by name.

Download a specific client file using the new endpoint.

Download the latest Transkribus GUI version.

Retrieve server events and notifications.

Get the current Transkribus server version.

Submit a single image to the Transkribus Processing API for text recognition and get back a process ID. Supply exactly one of imageUrl or base64 (JPEG, TIFF or PNG, up to 20 MB).

Get the status of a Processing API job, including the recognised text once it has finished. Status is one of CREATED, WAITING, RUNNING, FINISHED or FAILED; results are kept for two days.

Get a finished Processing API result as PAGE XML (version 2013-07-15). Returns 404 while the job is still running.

Get a finished Processing API result as ALTO v4 XML. Returns 404 while the job is still running.