Get Queue Item

To get an item that has been added to a queue you can use the queue().getItem method.

index.ts

import { ContentMod } from "@contentmod/sdk";

const contentMod = new ContentMod({
  publicKey: "<YOUR_PUBLIC_KEY>",
  secretKey: "<YOUR_SECRET_KEY>",
});

const queueId = "<QUEUE_ID>";

const queue = contentMod.queue(queueId);

const itemId = "<ITEM_ID>";
// Add an item to the queue
const res = await queue.getItem(itemId);

console.log(res);

Response

The QueueItemResponse object contains the following properties:

string

required

The ID of the moderation request.Example: 27fbdc0b-b295-46ce-93f5-81b2fc08a381

type

string

required

The type of the item.Example: text

accepted

boolean

required

Wether the item has been accepted or not.Example: true

status

string

required

The status of the item. available status values are:

processing
pending
accepted
rejected

Example: accepted

content

string

required

The original content of the item.Example: Hello world

moderation

object

Show Moderation

string

required

The ID of the moderation request.Example: 27fbdc0b-b295-46ce-93f5-81b2fc08a381

isSafe

boolean

required

Whether the text is considered safe.Example: true

confidence

number

required

Confidence of the safety of the text from 1-100.Example: 90

sentiment

string

required

Sentiment of the text, either negative, neutral or positive.available sentiment values are:

negative
neutral (default)
positive

Example: positive

sentimentScore

number

required

Sentiment score from 1-100 (negative, neutral, positive).Example: 90

riskScores

object

required

Overall risk score from 1-100.Example: 90

topics

array

required

General topics the text depicts, lowercase and no punctuation.Example: ["politics", "sports"]

nsfwCategories

array

required

An array of the categories of the text. The available categories are:

adult_content
suggestive_imagery
strong_language
violence_gore
horror_disturbing
alcohol
tobacco
substance_use
gambling
dating_relationship
medical_procedures”
crude_humor
political_content

Example: [{"category": "sexual", "severity": 90}]

summary

object

required

Summary of the text.Example: {"profanity": true, "totalFlags": 1, "contentRating": "G", "language": "en"}

suggestedActions

object

required

Suggested actions for the text.

Hide Suggested Actions

reject

boolean

required

Whether to reject the text.Example: true

review

boolean

required

Whether to flag the text.Example: true

Example: {"reject": true, "review": true}

content

string

required

The original text.Example: This is the original text

filteredContent

string

required

The text with profanity replaced by *.Example: This is a filtered text

request

object

required

The request object.Example: {"requestId": "27fbdc0b-b295-46ce-93f5-81b2fc08a381", "timestamp": "2023-04-05T12:00:00.000Z"}

Get Started

Integrations

Queues

SDKS

Projects

Response

​Response

Response