REST API Reference

This page contains links to documentation of all service endpoints and parameters available in Carrot² REST API.

The documentation for the REST API is an integral part of the Open API descriptor. The documentation of service endpoints, parameters, as well as example requests and responses are all part of it.

You can browse the descriptor using one of the viewers provided with the DCS: once started, the documentation viewers are listed at http://localhost:8080/service/openapi.

We recommend Swagger because it handles the examples and interactive queries best, even if it lacks in the design department.

The reference documentation of each algorithm's parameters comes with pseudo-JSON sections nearly ready to be copy-pasted into clustering requests:

• Lingo parameters,
• STC parameters,
• Bisecting k-means parameters.