Semantria
  1. Status
Semantria
  • Blacklist
    • Remove items from blacklist
      DELETE
    • Retrieve blacklisted items
      GET
    • Add items to blacklist
      POST
    • Update items in blacklist
      PUT
  • Categories
    • Remove user categories
      DELETE
    • Retrieve user categories
      GET
    • Add user categories
      POST
    • Updates user categories
      PUT
  • ProcessingCollections
    • Queue collection for analysis
      POST
    • Retrieve collections analysis
      GET
    • Cancel collection analysis
      DELETE
    • Retrieve collection analysis or its status in queue
      GET
  • Configuration
    • Remove user configurations
      DELETE
    • Retrieve user configurations
      GET
    • Create user configurations
      POST
    • Update user configurations
      PUT
  • ProcessingDocuments
    • Queue document for analysis
      POST
    • Queue batch of documents for analysis
      POST
    • Retrieve documents analysis
      GET
    • Cancel document analysis
      DELETE
    • Retrieve document analysis or its status in queue
      GET
  • Entities
    • Remove user entities
      DELETE
    • Retrieve user entities
      GET
    • Add user entities
      POST
    • Update user entities
      PUT
  • Features
    • Retrieve supported features
  • Phrases
    • Remove sentiment-bearing phrases
    • Retrieve sentiment-bearing phrases
    • Add sentiment-bearing phrases
    • Updates sentiment-bearing phrases
  • Queries
    • Remove queries
    • Retrieve queries
    • Add or update queries
    • Update queries
  • Statistics
    • Retrieve usage statistics
  • Status
    • Retrieve API status
      GET
  • Subscription
    • Retrieve subscription details
  • Taxonomy
    • Remove taxonomy nodes
    • Retrieve taxonomy
    • Add taxonomy nodes
    • Update taxonomy nodes
  1. Status

Retrieve API status

GET
/status.{content_type}
This method retrieves API status information such as the app version, current API version, supported languages and encodings, the overall service status, etc.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.semantria.com//status.'
Response Response Example
200 - Example 1
{
    "api_version": "string",
    "service_status": "available",
    "service_version": "string",
    "supported_compression": "string",
    "supported_encoding": "string",
    "supported_languages": [
        "string"
    ]
}

Request

Path Params
content_type
string 
required

Responses

🟢200Client request accepted. Server responds with status object.
application/json
Body
api_version
string 
required
Represents current version of the exposed API
service_status
enum<string> 
required
Represents the availability of the service
Allowed values:
availablependingsold
service_version
string 
required
Represents current version of the Semantria service
supported_compression
string 
required
Exposes supported compression algorithms. Currently only gzip and deflate are supported
supported_encoding
string 
required
Exposes supported content encoding. Currently only UTF-8 is supported
supported_languages
array[string]
required
Exposes list of supported languages
🟠401Authentication failed.
🟠402Unauthorized. Limit of system calls is reached or subscription is expired.
🔴500Server side issue. Server may respond with the details in response body.
Modified at 2022-09-10 18:38:13
Previous
Retrieve usage statistics
Next
Retrieve subscription details
Built with