PurgoMalum API Documentation

CheckIfTextContainsProfanity

containsprofanityGet

Check if text contains profanity


/containsprofanity

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/purgomalum/containsprofanity?text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckIfTextContainsProfanityApi;

import java.io.File;
import java.util.*;

public class CheckIfTextContainsProfanityApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CheckIfTextContainsProfanityApi apiInstance = new CheckIfTextContainsProfanityApi();
        String apiecoKey = apiecoKey_example; // String | 
        String text = text_example; // String | 
        try {
            'Boolean' result = apiInstance.containsprofanityGet(apiecoKey, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckIfTextContainsProfanityApi#containsprofanityGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckIfTextContainsProfanityApi;

public class CheckIfTextContainsProfanityApiExample {

    public static void main(String[] args) {
        CheckIfTextContainsProfanityApi apiInstance = new CheckIfTextContainsProfanityApi();
        String apiecoKey = apiecoKey_example; // String | 
        String text = text_example; // String | 
        try {
            'Boolean' result = apiInstance.containsprofanityGet(apiecoKey, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckIfTextContainsProfanityApi#containsprofanityGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *text = text_example; // 

CheckIfTextContainsProfanityApi *apiInstance = [[CheckIfTextContainsProfanityApi alloc] init];

// 
[apiInstance containsprofanityGetWith:apiecoKey
    text:text
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PurgoMalumApiDocumentation = require('purgo_malum_api_documentation');
var defaultClient = PurgoMalumApiDocumentation.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new PurgoMalumApiDocumentation.CheckIfTextContainsProfanityApi()

var apiecoKey = apiecoKey_example; // {String} 

var text = text_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containsprofanityGet(apiecoKey, text, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containsprofanityGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CheckIfTextContainsProfanityApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var text = text_example;  // String | 

            try
            {
                // 
                'Boolean' result = apiInstance.containsprofanityGet(apiecoKey, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckIfTextContainsProfanityApi.containsprofanityGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CheckIfTextContainsProfanityApi();
$apiecoKey = apiecoKey_example; // String | 
$text = text_example; // String | 

try {
    $result = $api_instance->containsprofanityGet($apiecoKey, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckIfTextContainsProfanityApi->containsprofanityGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CheckIfTextContainsProfanityApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckIfTextContainsProfanityApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $text = text_example; # String | 

eval { 
    my $result = $api_instance->containsprofanityGet(apiecoKey => $apiecoKey, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CheckIfTextContainsProfanityApi->containsprofanityGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckIfTextContainsProfanityApi()
apiecoKey = apiecoKey_example # String | 
text = text_example # String | 

try: 
    # 
    api_response = api_instance.containsprofanity_get(apiecoKey, text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckIfTextContainsProfanityApi->containsprofanityGet: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
text*
String
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input


RemoveProfanity

removeprofanity

Calling the web service involves a simple HTTP GET request. The only two requirements for using PurgoMalum are the "text" parameter on the query string and the request-type name as part of the path in the request


/json

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/purgomalum/json?fill_text=&add=&fill_char="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RemoveProfanityApi;

import java.io.File;
import java.util.*;

public class RemoveProfanityApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        RemoveProfanityApi apiInstance = new RemoveProfanityApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer tezt = 56; // Integer | 
        String fillText = fillText_example; // String | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
        String add = add_example; // String | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
        String fillChar = fillChar_example; // String | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.
        try {
            inline_response_200 result = apiInstance.removeprofanity(apiecoKey, tezt, fillText, add, fillChar);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RemoveProfanityApi#removeprofanity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RemoveProfanityApi;

public class RemoveProfanityApiExample {

    public static void main(String[] args) {
        RemoveProfanityApi apiInstance = new RemoveProfanityApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer tezt = 56; // Integer | 
        String fillText = fillText_example; // String | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
        String add = add_example; // String | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
        String fillChar = fillChar_example; // String | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.
        try {
            inline_response_200 result = apiInstance.removeprofanity(apiecoKey, tezt, fillText, add, fillChar);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RemoveProfanityApi#removeprofanity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
Integer *tezt = 56; // 
String *fillText = fillText_example; // Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
String *add = add_example; // A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
String *fillChar = fillChar_example; // Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.

RemoveProfanityApi *apiInstance = [[RemoveProfanityApi alloc] init];

// 
[apiInstance removeprofanityWith:apiecoKey
    tezt:tezt
    fillText:fillText
    add:add
    fillChar:fillChar
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PurgoMalumApiDocumentation = require('purgo_malum_api_documentation');
var defaultClient = PurgoMalumApiDocumentation.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new PurgoMalumApiDocumentation.RemoveProfanityApi()

var apiecoKey = apiecoKey_example; // {String} 

var tezt = 56; // {Integer} 

var fillText = fillText_example; // {String} Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.

var add = add_example; // {String} A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.

var fillChar = fillChar_example; // {String} Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeprofanity(apiecoKey, tezt, fillText, add, fillChar, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeprofanityExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new RemoveProfanityApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var tezt = 56;  // Integer | 
            var fillText = fillText_example;  // String | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
            var add = add_example;  // String | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
            var fillChar = fillChar_example;  // String | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.

            try
            {
                // 
                inline_response_200 result = apiInstance.removeprofanity(apiecoKey, tezt, fillText, add, fillChar);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RemoveProfanityApi.removeprofanity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\RemoveProfanityApi();
$apiecoKey = apiecoKey_example; // String | 
$tezt = 56; // Integer | 
$fillText = fillText_example; // String | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
$add = add_example; // String | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
$fillChar = fillChar_example; // String | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.

try {
    $result = $api_instance->removeprofanity($apiecoKey, $tezt, $fillText, $add, $fillChar);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RemoveProfanityApi->removeprofanity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RemoveProfanityApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RemoveProfanityApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $tezt = 56; # Integer | 
my $fillText = fillText_example; # String | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
my $add = add_example; # String | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
my $fillChar = fillChar_example; # String | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.

eval { 
    my $result = $api_instance->removeprofanity(apiecoKey => $apiecoKey, tezt => $tezt, fillText => $fillText, add => $add, fillChar => $fillChar);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RemoveProfanityApi->removeprofanity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RemoveProfanityApi()
apiecoKey = apiecoKey_example # String | 
tezt = 56 # Integer | 
fillText = fillText_example # String | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
add = add_example # String | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
fillChar = fillChar_example # String | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.

try: 
    # 
    api_response = api_instance.removeprofanity(apiecoKey, tezt, fillText, add, fillChar)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RemoveProfanityApi->removeprofanity: %s\n" % e)

Parameters

Path parameters
Name Description
tezt*
Integer
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
fill_text*
String
Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes (|), single quotes ('), double quotes ("), asterisks (), open and closed curly brackets ({ }), square brackets ([ ]) and parentheses (). Maximum length of 20 characters. When not used, the default is an asterisk () fill.
Required
add*
String
A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of you entry is not important.
Required
fill_char*
String
Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe (|) and asterisk (). When not used, the default is an asterisk () fill.
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input