AI Services

Moderate Text Content using AI

Changed on Oct 20, 2023

This endpoint is used to moderate text content using AI. It accepts a JSON object containing the text moderation parameters and returns the the moderation results.

post/api/ai/moderation

Request

Base URL
https://api.worqhat.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/docs/api/ai/moderation/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

text_contentstring

The text to be moderated.

Response

Text moderated successfully

statusstring

Status indicating the success of the text moderation.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

Example response

{
  "status": "success",
  "moderation": {
    "sexual": "0.016973",
    "hate": "0.001243",
    "harassment": "0.012784",
    "self-harm": "0.000040",
    "sexual/minors": "0.000049",
    "hate/threatening": "0.000002",
    "violence/graphic": "0.000016",
    "self-harm/intent": "0.000059",
    "self-harm/instructions": "0.000007",
    "harassment/threatening": "0.000002",
    "violence": "0.000333"
  },
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 3
}

Changes

Oct 20, 2023871850b7231f Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id moderationContent removed and replaced with moderateText
- info
  the endpoint scheme security bearerAuth was added to the API
- info
  api tag AI Services added
- info
  api tag AI removed
- info
  the request property became optional
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Aug 15, 2023b5ffe2a9748f Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  api operation id moderationContent was added
- info
  api tag AI added
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (5 revisions)