---
canonical_url: "https://docs.composio.dev/toolkits/moderationapi"
markdown_url: "https://docs.composio.dev/toolkits/moderationapi.md"
product: "platform"
version: null
last_updated: null
---

# Moderation API

Moderation API provides content detection, human review workflows, author management, and moderation actions for online platforms.

- **Category:** ai safety compliance detection
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `MODERATIONAPI`
- **Version:** 00000000_00

## Tools

### Evaluate Content Without Storage

**Slug:** `MODERATIONAPI_EVALUATE_CONTENT`

Evaluate content without retaining it or adding it to a review queue, and return policy findings and the recommended moderation action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string | No | Channel ID or key; omit to use the project's default channel. |
| `content` | string | Yes | Text, image, video, audio, or structured object content to moderate. |
| `metadata` | object | No | Caller metadata to include with the moderation request. |
| `author_id` | string | No | External author ID to associate with the content. |
| `meta_type` | string ("profile" | "message" | "post" | "comment" | "event" | "product" | "review" | "voice" | "other") | No | Business type of the submitted content. |
| `timestamp` | number | No | Unix timestamp in milliseconds when non-real-time content was created. |
| `content_id` | string | No | Stable content ID from the caller's system. |
| `client_action` | object | No | Optional caller recommendation combined with the provider recommendation. |
| `conversation_id` | string | No | Conversation, room, thread, or parent-post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Moderation Action

**Slug:** `MODERATIONAPI_EXECUTE_ACTION`

Apply a discovered moderation action to content items or authors. Actions can reject content or block or suspend authors and may be irreversible; inspect LIST_ACTIONS before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | No | Action value when LIST_ACTIONS reports that a value is required. |
| `queue_id` | string | No | Queue ID when executing a queue-specific action. |
| `action_key` | string | Yes | Action ID or key returned by LIST_ACTIONS. |
| `author_ids` | array | No | Author IDs to act on; provide author_ids, content_ids, or both. |
| `content_ids` | array | No | Content IDs to act on; provide content_ids, author_ids, or both. |
| `duration_ms` | number | No | Duration in milliseconds for a temporary action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account and Quota

**Slug:** `MODERATIONAPI_GET_ACCOUNT`

Return the connected Moderation API account, plan, current project, and current quota values.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review Queue

**Slug:** `MODERATIONAPI_GET_REVIEW_QUEUE`

Return metadata and item counts for a review queue by ID. Requires the paid review-queue add-on; contact Moderation API sales if review queues are not enabled for the connected organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queue_id` | string | Yes | Review queue ID obtained from the Moderation API dashboard or configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Wordlist

**Slug:** `MODERATIONAPI_GET_WORDLIST`

Return one wordlist and its current words by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `wordlist_id` | string | Yes | Wordlist ID returned by LIST_WORDLISTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Moderation Actions

**Slug:** `MODERATIONAPI_LIST_ACTIONS`

List moderation actions available to the organization, optionally restricted to a review queue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queue_id` | string | No | Return actions available for this review queue ID; omit to return all organization actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Review Queue Items

**Slug:** `MODERATIONAPI_LIST_REVIEW_QUEUE_ITEMS`

List and filter one page of moderation items in a review queue. Requires the paid Moderation API review-queue add-on.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page and pass it back unchanged to fetch the next page. |
| `queue_id` | string | Yes | Review queue ID. |
| `author_id` | string | No | Only return items associated with this author ID. |
| `page_size` | integer | No | Maximum number of queue items to return in this page. |
| `sort_field` | string ("createdAt" | "severity" | "reviewedAt") | No | Field used to order queue items. |
| `sort_direction` | string ("asc" | "desc") | No | Direction used to order queue items. |
| `include_resolved` | boolean | No | Whether to include resolved queue items in the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Wordlists

**Slug:** `MODERATIONAPI_LIST_WORDLISTS`

List the organization's wordlists and their identifiers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Modify Wordlist Words

**Slug:** `MODERATIONAPI_MODIFY_WORDLIST_WORDS`

Add words to or remove words from an existing wordlist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `words` | array | Yes | Non-empty words to add or remove; duplicate additions are ignored. |
| `operation` | string ("add" | "remove") | Yes | Whether to add the supplied words or remove them. |
| `wordlist_id` | string | Yes | Wordlist ID returned by LIST_WORDLISTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Review Queue Item Status

**Slug:** `MODERATIONAPI_SET_REVIEW_QUEUE_ITEM_STATUS`

Mark a review queue item resolved or return it to pending. Requires the paid review-queue add-on.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("resolved" | "pending") | Yes | Desired queue item status: resolved or pending. |
| `comment` | string | No | Optional reason for the status change. |
| `item_id` | string | Yes | Queue item ID returned by LIST_REVIEW_QUEUE_ITEMS. |
| `queue_id` | string | Yes | Review queue ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Content for Moderation

**Slug:** `MODERATIONAPI_SUBMIT_CONTENT_FOR_MODERATION`

Evaluate content and allow Moderation API to retain it and add it to a review queue according to the project's configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string | No | Channel ID or key; omit to use the project's default channel. |
| `content` | string | Yes | Text, image, video, audio, or structured object content to moderate. |
| `metadata` | object | No | Caller metadata to include with the moderation request. |
| `author_id` | string | No | External author ID to associate with the content. |
| `meta_type` | string ("profile" | "message" | "post" | "comment" | "event" | "product" | "review" | "voice" | "other") | No | Business type of the submitted content. |
| `timestamp` | number | No | Unix timestamp in milliseconds when non-real-time content was created. |
| `content_id` | string | No | Stable content ID from the caller's system. |
| `client_action` | object | No | Optional caller recommendation combined with the provider recommendation. |
| `conversation_id` | string | No | Conversation, room, thread, or parent-post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |