Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Welcome

  • Article
  • 2 minutes to read

Welcome to the user guide for Hornbill Platform API. In this guide, you will learn everything you need to know about using our API to its full potential. Whether you are new to the Hornbill API or have been using it for a while, this guide will provide you with all the information you need to get started and make the most of what our platform has to offer.

The Hornbill API is designed to give you access to a broad range of Hornbill Platform and Application filters. Whether you need to perform simple automatons or complex integrations from other systems, our API has been designed with your needs in mind. With its industry-standards based design and flexible options, the Hornbill API is well documented, accessible, and easy to use.

In this guide, we will cover the basics of the Hornbill API, including how to discover and connect to your instance, authenticate and make some API calls. We will also dive into some of the more advanced features, such as working with file content, security and diagnostic features, to help you get the most out of the Hornbill API.

We have tried to make this guide as comprehensive and clear as possible, so you can easily find the information you need. If you have any questions or need additional help, our support team is always available to assist you.

So, let’s get started! With the help of this guide, you will soon be able to work with our APIs and make the most of Hornbill’s capabilities.

Who is this guide for

This guide is for anyone that needs to work with the Hornbill Platform and/or Application APIs in order to integrate and/or automate functions within Hornbill from other systems.

This guide is a technical guide and requires you to have at least a basic/fundamental working knowledge of the following developer-related subjects: -

How to use this guide

Hornbill has combined many years of experience with modern standards based technologies in order to create a powerful and flexible API system for its products. Although the components we used to create the Hornbill API are well defined and standards-based, you can think of the Hornbill API as a recipe that brings these components together an a way that is very familiar, yet unique to Hornbill. Before you use the Hornbill API for anything serious, you should read the complete API Guide in the order it is presented in the document index. The API Reference section will act as a reference to the services, APIs, and types as needed once you are working with the APIs.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document