Skip to main content
JavaScript
import ModerationAPI from '@moderation-api/sdk';

const client = new ModerationAPI({
  secretKey: process.env['MODAPI_SECRET_KEY'], // This is the default and can be omitted
});

const response = await client.actions.execute.execute({ actionKey: 'actionKey' });

console.log(response.success);
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.moderationapi.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Input parameters

​
actionKey
string
required

ID or key of the action to execute

​
contentIds
string[]

IDs of the content items to apply the action to. Provide this or authorIds.

​
authorIds
string[]

IDs of the authors to apply the action to. Provide this or contentIds.

​
value
string

Optional value to provide with the action

​
queueId
string

Optional queue ID if the action is queue-specific

​
duration
number

Optional duration in milliseconds for actions with timeouts

Required range: x >= 0

Response

Action executed successfully

Execution result

​
success
boolean
required

Whether the action was executed successfully