README

Content Profanity Detector API for PHP

📝 Detect profanities in text using AI - identifies inappropriate language

Check the full documentation on the Content Profanity Detector API for PHP API page.

Quick Links

Resource	Link
Main API Documentation	Authorization, Webhooks, Polling & More
Product Details	SharpAPI.com
SDK Libraries	GitHub - SharpAPI SDKs

Requirements

PHP >= 8.0

Installation

Step 1. Install the package via Composer:

composer require sharpapi/php-content-profanity-detector

Step 2. Visit SharpAPI to get your API key.

Laravel Integration

Building a Laravel application? Check the Laravel package version for better integration.

What it does

Detect profanities in text using AI - identifies inappropriate language

Usage

<?php

require __DIR__ . '/vendor/autoload.php';

use SharpAPI\ContentProfanity\ProfanityDetectorClient;
use GuzzleHttp\Exception\GuzzleException;

$apiKey = 'your_api_key_here';
$client = new ProfanityDetectorClient(apiKey: $apiKey);

try {
    $statusUrl = $client->detectProfanities(
        content: 'Your text content here'
    );

    // Optional: Configure polling
    $client->setApiJobStatusPollingInterval(10);
    $client->setApiJobStatusPollingWait(180);

    // Fetch results (polls automatically)
    $result = $client->fetchResults($statusUrl);
    $resultData = $result->getResultJson();

    echo $resultData;
} catch (GuzzleException $e) {
    echo "API error: " . $e->getMessage();
}

Example Response


{
    "data": {
        "type": "api_job_result",
        "id": "06f4a1ba-b6b1-48b3-b071-807e3d41db4d",
        "attributes": {
            "status": "success",
            "type": "content_detect_profanities",
            "result": []
        }
    }
}

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

A2Z WEB LTD
Dawid Makowski
Boost your PHP AI capabilities!

License

The MIT License (MIT). Please see License File for more information.

Social Media

🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:

sharpapi / php-content-profanity-detector

Maintainers

Package info

Statistics

Security