Skip to main content
Create a project

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

The project's name.

Required string length: 1 - 35
domain
string

The website or app the project moderates content for. Used to write the context when none is given.

Maximum string length: 255
context
string

What the platform is and who uses it.

Maximum string length: 2000
brief
string

What you moderate, the problems you see and your guidelines.

Maximum string length: 2000
usedByMinors
boolean
default:false

Whether children use the platform.

Response

Project created successfully

id
string
required

The ID of the project.

name
string
required

The project's name.

description
string | null
required

The project's description.

domain
string | null
required

The website or app the project moderates content for.

context
string | null
required

What the platform is and who uses it. AI moderation reads it to judge content in context.

globalFlaggingMode
enum<string>
required

ACTIVE flags content. DRY_RUN evaluates content without flagging it, for testing a setup.

Available options:
DRY_RUN,
ACTIVE
enableRequestLogging
boolean
required

Whether moderated content is stored and shown in the dashboard.

casebookEnabled
boolean
required

Whether decisions made in the review queue are recorded in the project's casebook.

createdAt
string
required

When the project was created.

updatedAt
string
required

When the project was last changed.

secretKey
string
required

A secret API key for the new project. Use it to moderate content in this project. It is also shown in the project's settings.