Skip to content

Home

Jump to bottom
Pieter Verschaffelt edited this page Mar 10, 2025 · 6 revisions

Welcome to the internal documentation of the Unipept API. This wiki provides an overview of all private API endpoints available in the Unipept API, including their functionality, configuration options, and usage examples. The documentation is structured to offer a detailed reference for developers integrating with the API or configuring its behavior.

Private API endpoints

How to use this documentation

Each API endpoint has its own dedicated page, accessible from the list below. These pages include:

  • Endpoint Description: A high-level explanation of what the endpoint does.
  • Configuration Options: An overview of all available configuration options, including their possible values and default settings.
  • Request and Response Examples: Sample API requests and corresponding responses to help illustrate usage.
  • Additional Notes: Relevant details or caveats to consider when using the endpoint.

Available endpoints

Below is a list of all private API endpoints. Click on an endpoint name to navigate to its detailed documentation page.

Deploying and setting up Unipept API

Below is a list of links to comprehensive guides that walk you through the process of installing and deploying the Unipept API on a server. These resources provide step-by-step instructions, ensuring a smooth setup and configuration tailored to your specific environment and requirements.

Clone this wiki locally