Skip to main content
Update a project

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the project to update.

Body

application/json
name
string

The project's name.

Required string length: 1 - 75
description
string | null

The project's description.

Maximum string length: 500
domain
string<uri> | null

The website or app the project moderates content for. Setting it on a project without context writes one.

context
string | null

What the platform is and who uses it.

Maximum string length: 2000
globalFlaggingMode
enum<string>

ACTIVE flags content. DRY_RUN evaluates without flagging.

Available options:
DRY_RUN,
ACTIVE
enableRequestLogging
boolean

Whether moderated content is stored and shown in the dashboard.

casebookEnabled
boolean

Whether review queue decisions are recorded in the casebook.

Response

Project updated 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.