Skip to content

Ban Word

POST
/api/writing/entities/ban

Ban a word from entity detection for the active project.

EntityBanRequest

Request to ban a word from entity detection.

object
word
required
Word

Word to ban

string
>= 1 characters

Successful Response

EntityBanResponse

Response from banning/unbanning a word.

object
status
required
Status
string
word
required
Word
string
action
required
Action

‘banned’ or ‘unbanned’

string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object