Version: 1.0.0
Last Updated: 18th Jan, 2024

Get Started

"The AI Purity API enables seamless scanning of text and files, as well as file downloading capabilities, through a straightforward and efficient interface.
To begin utilizing these services, an API key is required."

To Scan Text you need to make a POST call to the following url :
https://www.ai-purity.com/wp-json/v1/scan/text

$url = "https://www.ai-purity.com/wp-json/v1/
scan/text";
$curl = curl_init();
curl_setopt(
    $curl, 
    CURLOPT_URL, 
    $url
);
curl_setopt($curl, CURLOPT_HTTPHEADER, 
array('
    Accept: application/json', 
    'Content-Type: application/json')
);
curl_setopt(
    $curl, 
    CURLOPT_RETURNTRANSFER, 
    true
);
$data = {
    "apikey": 'your api key',
    "string": "text for scan",
}
curl_setopt(
    $curl, 
    CURLOPT_POSTFIELDS, 
    $data
);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;

Parameters

Field Type Description
apikey String Your API key.
string String For scan text

Test Your API

Response

To Scan file with url you need to make a POST call to the following url :
https://www.ai-purity.com/wp-json/v1/scan/file

$url = "https://www.ai-purity.com/wp-json/v1
/scan/file";
$curl = curl_init();
curl_setopt(
    $curl, 
    CURLOPT_URL, 
    $url
);
curl_setopt($curl, CURLOPT_HTTPHEADER, 
array('
    Accept: application/json', 
    'Content-Type: application/json')
);
curl_setopt(
    $curl, 
    CURLOPT_RETURNTRANSFER, 
    true
);
$data = {
"apikey": 'your api key',
"url": "file url",
}
curl_setopt(
    $curl, 
    CURLOPT_POSTFIELDS, 
    $data
);
$resp = curl_exec($curl);
curl_close($curl);

echo $resp;

Parameters

Field Type Description
apikey String Your API key.
URL URL For scan file

Test Your API

Response

To Scan file by uploading file you need to make a POST call to the following url :
https://www.ai-purity.com/wp-json/v1/scan/uploadfile

$url = "https://www.ai-purity.com/wp-json/v1
/scan/uploadfile";
$curl = curl_init();
curl_setopt(
    $curl, 
    CURLOPT_URL, 
    $url
);
curl_setopt($curl, CURLOPT_HTTPHEADER, 
array('
    Accept: application/json', 
    'Content-Type: application/json')
);
curl_setopt(
    $curl, 
    CURLOPT_RETURNTRANSFER, 
    true
);
$data = {
"apikey": 'your api key',
"file": "upload your file",
}
curl_setopt(
    $curl, 
    CURLOPT_POSTFIELDS, 
    $data
);
$resp = curl_exec($curl);
curl_close($curl);

echo $resp;

Parameters

Field Type Description
apikey String Your API key.
File File For scan file

Test Your API

Response

To download PDF file you need to make a POST call to the following url :
https://www.ai-purity.com/wp-json/v1/scan/downloadfile


$url = "https://www.ai-purity.com/wp-json/v1
/scan/downloadfile";
$curl = curl_init();
curl_setopt(
    $curl, 
    CURLOPT_URL, 
    $url
);
curl_setopt($curl, CURLOPT_HTTPHEADER, 
array('
    Accept: application/json', 
    'Content-Type: application/json')
);
curl_setopt(
    $curl, 
    CURLOPT_RETURNTRANSFER, 
    true
);
$data = {
"apikey": 'your api key',
"filename": "file name",
}
curl_setopt(
    $curl, 
    CURLOPT_POSTFIELDS, 
    $data
);
$resp = curl_exec($curl);
curl_close($curl);

echo $resp;

Parameters

Field Type Description
apikey String Your apikey.
Filename string For Download file

Test Your API

Response

Errors

The AI Purity API uses the following error codes:

Error Code Meaning
400 Some parameters are missing. This error appears when you don't pass every mandatory parameters.
415 Your file is not supported! Please try another file/text!
422 Your text is too small. Please provide more data for more accurate results.
442 This entry is greater than your remaining quota. Only "Your Words Quota" words are left from your monthly quota.

NOTES

The AI Purity API uses the following notes:

Notes Meaning
free_version_limit_error AI Purity's Basic version only uncovers the first 5,000 characters. Enjoy our Pro features by registering or logging in.
Short_text_ERROR For in-depth scan, your texts must contain at least two sentences, each of at least 5 words! Please ensure your sentences end with a period, question mark, or exclamation point.
premium_display_limit_error AI Purity only displays the first 5,000 characters on the website. To see full results, please download our detailed PDF Report.

*When ERRORs occur the model doesn't scan the text, but NOTEs are output together with the results by the model.

Release Notes: AI Purity API

Welcome to the release notes page for AI Purity API! Here, we provide updates on new features, improvements, and fixes to ensure you have the best experience with our API. As we are constantly working to enhance our services, we encourage you to check back often for the latest updates

Version 1.1.0 - Launch Release

Date: 04/04/24

We are excited to announce significant improvements to our main AI Text Detection Model and to share some plans for the near future.

New Updates

  • New AI Detection Model: We have now rolled out a new version of our proprietary and state-of-the-art AI Detection Model.

New Features

  • AI Detection Model’s New Human Resource Capabilities – We have now also improved our model to assist Human Resource Departments better.

Improvements

  • Enhanced Models: We have introduced newly fine-tuned hybrid models to ensure our accuracy scores continue to be reliable and trustworthy, despite the ever-evolving landscape of AI Text Generation.
  • Enhanced Capabilities: This new model has now been trained on Human Resource related material and is now capable of detecting AI-Generated Cover Letters & Resumes.

Known Issues and Limitations

  • AI Detection Model Limitations: No immediate issues, but we will have to continue to monitor and improve the complex structure of the current models to ensure it is up to standard and accuracy scores remain high.
  • AI Detection Model’s Speed: When the size of a text is unusually large, our tool may take a few seconds to provide the full results.

Coming Soon

  • Next Generation Models: We are working diligently behind the scenes to further upgrade our current models. Specific details will be shared very soon!
    • Enhanced Scan Algorithms: Continuous improvements to our scanning algorithms to provide more accurate and comprehensive results.
  • AI Detection Model Speed Optimization: We will be deploying constant updates to further optimize the tool’s speed in the coming weeks.
  • Adaptive Learning Tools: We are currently working on new tools that will further add value to our main AI Detection Tool and will be able to share more details soon.

Support

Encountering issues or have questions? Our support team is here to help.

Version 1.0.0 - Launch Release

Date: 01/31/24

We are excited to announce the launch of AI Purity API! Our API is designed to offer powerful text and file scanning capabilities, making it easier for developers and businesses to ensure content purity and compliance.

New Features

  • API Key Access: Secure access to the AI Purity API. Users are required to sign in and generate an API key for API usage.
  • Scan Text: Introducing the ability to scan text for content purity. Simply make a POST call to our endpoint with your API key and the text you wish to scan.
  • Scan File by URL: Easily scan files for content purity by providing a URL to the file you wish to scan.
  • File Upload for Scanning: We now support scanning files directly uploaded to our API, enhancing the flexibility of content scanning.
  • Download Scanned Files: After scanning, files can be directly downloaded which will provide a seamless workflow for managing scanned content.

Improvements

  • Enhanced Error Handling: We have introduced detailed error codes and messages to help you understand exactly what went wrong and how to fix it.
  • Documentation and Starter Code: Comprehensive documentation and starter code are available to help you get started with integrating our API into your applications.

Known Issues and Limitations

  • Free Version Limitations: The Basic version of AI Purity API limits scans to the first 5,000 characters. Upgrade to Pro for full access.
  • Text Size Requirements: For effective scanning, texts must contain at least two sentences with a minimum of 5 words each.
  • Premium Display Limits: The display of scanned content is limited to the first 5,000 characters on our website. Full results are available via a detailed PDF report.

Coming Soon

  • Expanded File Type Support: We are working on adding support for more file types as we aim to broaden the scope of content that can be scanned.
  • Enhanced Scan Algorithms: Continuous improvements to our scanning algorithms to provide more accurate and comprehensive results.

Support

Encountering issues or have questions? Our support team is here to help.

Contact us for assistance

Pin It on Pinterest