API endpoints

The endpoints of Studio LDA API are the addresses—or URLs—of its resources.
Together with the JSON object that makes up the payload of each request, they exactly identify the resource that the API should return.

The first part of the endpoint, being an URL, is always the protocol, host and port specification, and by default it is:

https://localhost:6699

The TCP port number, 6699, can be changed using Studio settings.

The remainder of the endpoint is the resource path and it varies based on the type of functionality required:

• All text analysis resources, whether document analysis, document classification or information extraction, share this path:

  /api/analyze
  

• Self-documentation resources—categories' tree, templates—have this path:

  /api/model
  

Info

The Python and Java SDKs available on GitHub automatically take care of building the proper endpoint for each request so you don't have to worry about that.