Skip to main content
Create a channel

Authorizations

Authorization
string
header
required

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

Path Parameters

projectId
string
required

The ID of the project to add the channel to.

Body

application/json
name
string
required

The channel's name.

Required string length: 1 - 100
key
string

The key you pass as channel when you moderate content. Defaults to the name in lowercase with dashes. Must be unique in the project.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9_-]+$
description
string

The channel's description.

Maximum string length: 500
contentType
enum<string>

The kind of content the channel moderates.

Available options:
profile,
message,
post,
comment,
event,
product,
review,
voice,
other

Response

Channel created successfully

id
string
required

The ID of the channel.

projectId
string
required

The ID of the project the channel is in.

key
string
required

The key you pass as channel when you moderate content. Unique in the project.

name
string
required

The channel's name.

description
string | null
required

The channel's description.

isDefault
boolean
required

Whether requests that name no channel use this one. Each project has one default channel.

contentType
enum<string> | null
required

The kind of content the channel moderates.

Available options:
profile,
message,
post,
comment,
event,
product,
review,
voice,
other
flaggingMode
enum<string>
required

ACTIVE flags content. DRY_RUN evaluates content without flagging it.

Available options:
DRY_RUN,
ACTIVE
contextEnabled
boolean
required

Whether earlier messages in the conversation are read when moderating a message.

enableImageModeration
boolean
required

Whether images are moderated.

enableVideoModeration
boolean
required

Whether videos are moderated.

enableAudioModeration
boolean
required

Whether audio is moderated.

enableVoiceModeration
boolean
required

Whether real-time voice streams are moderated.

includeTranscriptInResponse
boolean
required

Whether audio and video transcripts are returned in responses.

transcriptionQuality
enum<string>
required

Trade-off between transcription speed and accuracy.

Available options:
SPEED,
BALANCED,
ACCURACY
unicodeSpoofDetectionEnabled
boolean
required

Whether look-alike Unicode characters are normalized before moderation.

frameCaptureInterval
number
required

Seconds between frames captured from a video.

Required range: 0.1 <= x <= 60
maxFramesPerVideo
integer
required

The most frames moderated per video.

Required range: 1 <= x <= 1000
spreadFrames
boolean
required

Whether frames are spread evenly across the whole video.

createdAt
string
required

When the channel was created.

updatedAt
string
required

When the channel was last changed.