Developer's how-to
The Studio LDA API is a software service with a REST interface that accepts and returns JSON objects.
Whenever a client program has to analyze a text, it must request an API resource. This is similar to what you do when you request the page of a site with a Web browser: Studio LDA API is "similar" to a Web site thet runs inside Studio, on your computer.
The request contains the API resource path—its URL, or endpoint—and the text of the document to be analyzed, classified and extracted. For this type of request the POST method is used.
Presented with this request, the service responds synchronously (after an amount of time depending on the type of processing requested and the complexity/length of the text) with the processing results.
You can use a variety of programming languages and frameworks—including C#, JavaScript, and NodeJS—to write che client code for the API, for example:
| Language | Framework |
|---|---|
| C | LibCurl |
| C# | HttpClient |
| C# | RestSharp |
| cURL | cURL |
| Dart | Dart |
| Go | http package |
| HTTP | (Raw HTTP request) |
| Java | OkHttp |
| Java | Unirest |
| JavaScript | Fetch |
| JavaScript | jQuery |
| JavaScript | XHR |
| NodeJS | Axios |
| NodeJS | Native |
| NodeJS | Request |
| NodeJS | Unirest |
| Objective-C | NSURLSession |
| OCaml | Cohttp |
| PHP | cURL |
| PHP | Guzzle |
| PHP | Http_Request2 |
| PHP | pecl_http |
| PowerShell | RestMethod |
| Python | http.client (Python 3) |
| Python | Requests |
| R | httr |
| R | RCurl |
| Ruby | NET::Http |
| Shell | Httpie |
| Shell | wget |
| Swift | URLSession |
In the reference section of this manual you can find all hthe information about:
- The API endpoints
- The format of the requests
- The format of JSON objects that the API resources return as responses.
- The possible HTTP status codes returned by the API endpoints.