Skip to main content
POST
/
moderation
/
keywords
Add Keywords
curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/moderation/keywords \
  --header 'Content-Type: multipart/form-data' \
  --header 'apikey: <api-key>' \
  --form category=word \
  --form 'searchTerms=AI-powered video moderation to detect unsafe content.' \
  --form 'file=<string>' \
  --form id=ID-of-the-word-list \
  --form 'name=Name of the word list' \
  --form 'description=Description of the word list' \
  --form 0.file='@example-file' \
  --form 1.file='@example-file' \
  --form 2.file='@example-file'
{
  "data": {
    "id": "profane-word-list-1",
    "name": "profane word list",
    "description": "Profane word list",
    "category": "word",
    "isCSV": true,
    "searchTerms": [
      "\"a\"",
      "\"b\"",
      "\"c\""
    ],
    "createdAt": 1720023805,
    "updatedAt": 1720023805,
    "revisionId": "253179cf5f665257_profane-word-list-1_1",
    "active": true
  }
}

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

multipart/form-data
  • Option 1
  • Option 2
  • Option 3
​
category
enum<string>
required

Type of entries in the list

Available options:
word,
pattern,
sentence-similarity
​
searchTerms
string
required

Comma-separated values of keywords or regex patterns if no file is provided.

Example:

"AI-powered video moderation to detect unsafe content."

​
file
file

CSV file containing the keywords or regex patterns for the list.

​
id
string

Unique identifier for the word list.

Example:

"ID-of-the-word-list"

​
name
string

Descriptive name for the word list.

Example:

"Name of the word list"

​
description
string

Detailed explanation of the word list's purpose.

Example:

"Description of the word list"

Response

200 - application/json

Created Keyword

​
data
object