REST API Reference

Lingo3G REST API comes with an OpenAPI descriptor that documents all endpoints, request parameters, input and output JSON structures, along with examples.

To browse the OpenAPI documentation, perform these steps:

  1. Start Lingo3G Document Clustering Server.

  2. Open http://localhost:8080/service/openapi for a list of available OpenAPI viewers.

    All viewers present the same specification, they differ in the visual and functional aspects. We recommend the Swagger viewer as it handles the examples and interactive querying best.

In addition to OpenAPI documentation, see also Lingo3G parameters for a complete list of Lingo3G parameter in a pseudo-JSON format for copying and pasting into your code.