Using the REST API

About the REST API

The ABBYY FineReader Server 14 Web Services API includes a SOAP API and a REST API. The REST API offers the same capabilities as the SOAP API but is easier to use.

The REST API uses the same data models as the SOAP API, so the sections of this guide that describe the data models are applicable to both versions of the API.

Below, you will find a brief description of the endpoints and methods of the REST API. Their SOAP counterparts will be indicated in each case. For a more detailed description, please refer to the Swagger specification and Swagger UI (the default location is http://localhost:8080/FineReaderServer14/swagger).

In the descriptions that follow, instead of writing out full endpoint addresses (i.e. http://localhost:8080/FineReaderServer14/api/{endpoint}), we will write simply /api/{endpoint}.

Workflows controller

Gets information about available workflows and submits files for processing.

Note. Not all workflow types are available to the API. For details, see this section: WebService.GetWorkflows.

The endpoints of this controller are described below.

Jobs controller

Gets information about jobs submitted for processing via the API. Such information includes jobs statuses and results.

The endpoints of this controller are described below.

Server controller (FineReader Server 14 Update 8 and later)

Gets general information about the server.

The endpoints of this controller are described below.

OutputFormats controller  (FineReader Server 14 R2 and later)

serverLocation parameter

The FineReader Server 14 Web Service and the FineReader Server 14 Server Manager may be installed on two different computers. To support this type of installation, each REST API method has an optional request parameter named serverLocation. The value of this parameter can be the IP address or the name of the computer where the FineReader Server 14 Server Manager is installed. The default value of this parameter is localhost (this address will be interpreted relative to the computer where the FineReader Server 14 Web Service is deployed).

For example, if the FineReader Server 14 Web Service and the FineReader Server 14 Server Manager are installed on the same computer named websrv, you can get a list of workflows using any of the following requests:

  • GET http://websrv:8080/FineReaderServer14/api/workflows
  • GET http://websrv:8080/FineReaderServer14/api/workflows?serverLocation=localhost
  • GET http://websrv:8080/FineReaderServer14/api/workflows?serverLocation=websrv

If the FineReader Server 14 Web Service is installed on a computer named websrv and the FineReader Server 14 Server Manager is installed on a computer named frs14srv, you can get a list of workflows using the following request:

  • GET http://websrv:8080/FineReaderServer14/api/workflows?serverLocation=frs14srv

29.08.2023 11:55:29

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.