OPL-AI API: Real-Time URL Classification
Welcome to the OPL-AI API! Our service offers a powerful and straightforward solution for classifying URLs in real time. Powered by an advanced artificial intelligence model, our API analyzes any given URL and returns its corresponding real-world category.OPL-AI continuously improves itself through ongoing training.
How It Works
The OPL-AI API uses a trained machine learning model to predict the category of a URL. By sending a simple request, our system processes the link and provides an accurate classification, helping you understand the nature of the content behind it.
To get started, you will need a **license key**. This key is essential for authenticating your requests and can be obtained by signing up on our website.
API Endpoint & Usage
All classification requests are made using a **HTTP GET** method. You must include both the target URL and your license key as query parameters in the request.
https://[your-api-address]/api/Utility/classifyurl?url=[url-to-classify]&licenceKey=[your-license-key]
- [your-api-address]: Your API's base URL (e.g.,
opl-ai.com). - [url-to-classify]: The full URL you want to classify (e.g.,
https://www.google.com). - [your-license-key]: Your unique license key from OPL-AI.
Example using Postman
To easily test the API, you can use a tool like Postman. Simply enter the API endpoint and add the url and licenceKey as query parameters in the "Params" tab.
API Responses
Successful Response:
A successful request with a valid license key will return a 200 OK status with the following JSON object:
{
"result": "S",
"url": "https://www.opl-ai.com",
"predictedClass": "analysismanagement"
}
Failed Response:
If the request fails (e.g., due to an expired license), you will receive an error status code (e.g., 400 Bad Request) and an error JSON object:
{
"result": "E",
"message": "Licence has expired."
}