1.16. REST API

1.16. REST API

Overview

The ADMET Predictor Service is an operating system service (currently available for Windows and Linux) that provides a web API for clients to access functionality of the ADMET Predictor software platform, including ADMET property prediction, metabolite prediction and pharmacokinetic simulation. The service is intended for use by third-party client applications, which communicate with the service over a network using JSON-formatted HTTP messages.

A full description of the service is provided in a separate document called ADMETPredictorService.pdf, located in the ADMETPredictorService subfolder of the main install folder. That folder also contains the official OpenAPI specification, ADMETPredictorService.json.

It is envisioned that prediction jobs submitted to the service will be relatively small, consisting of at most a few thousand compounds at a time, so that the service can support a large number of clients simultaneously. However, the service does not explicitly limit the job size.

Each operation supported by the service is designated using the universal resource identifier field (URI) of the HTTP message. For example, the URI /predict_admet is used for predicting ADMET properties. The URI REFERENCE section of the service manual contains a list of all supported URIs, along with the required HTTP message syntax for each request and the format of possible responses.

When the results of a request cannot be returned immediately, the request is added to a job queue. In such cases the response to the request contains a unique job ID that the client uses to request periodic status updates using the URI /getstatus. When the job is complete, the response to the status request will indicate completion and will contain the results.

The subfolder ADMETPredictorService/examples provides example files with JSON bodies of requests and responses. The manual section called EXAMPLE JSON FILES provides descriptions of these files.