Skip to main content
The moderation workflow lets you open, track, and close formal review cases against providers or agents. When you create a case, you can optionally trigger an immediate block or provider revocation so the subject is taken offline while the review is in progress.

Create a moderation case

Opens a new moderation case and returns the created ModerationCase. If auto_block is true, the target is blocked immediately. If auto_revoke_provider is true, the target provider is revoked immediately.

Request Body

string
required
The type of entity under review. Either "provider" or "agent".
string
required
The identifier of the provider or agent under review.
string
required
Identifier of the moderator or system opening this case.
string
required
Description of why this case is being opened.
boolean
If true, the target entity is blocked at case creation time. Defaults to false.
boolean
If true and target_kind is "provider", the provider is revoked at case creation time. Defaults to false.

Example


List moderation cases

Returns all moderation cases, optionally filtered by target entity or case status.

Query Parameters

string
Filter by target type. Either "provider" or "agent".
string
Filter by the identifier of the provider or agent under review.
string
Filter by case status. One of open, actioned, resolved, or rejected.

Example


Resolve a moderation case

Closes a moderation case and records the outcome. Optionally clears a block on the target or marks the case as rejected.

Path Parameters

string (UUID)
required
The UUID of the moderation case to resolve.

Request Body

string
required
Identifier of the moderator resolving this case.
string
required
Mandatory notes describing the resolution outcome.
boolean
If true, any active block on the target entity is lifted. Defaults to false.
boolean
If true, the case status is set to rejected rather than resolved. Defaults to false.

Example


Response

All three endpoints return a ModerationCase.
string (UUID)
required
Unique identifier for this moderation case.
string
required
Type of the entity under review. Either "provider" or "agent".
string
required
Identifier of the provider or agent under review.
string
required
Moderator or system that opened this case.
string
required
Description of why the case was opened.
string
required
Current case status. One of open, actioned, resolved, or rejected.
string
required
Action recorded against the target. One of none, provider_blocked, provider_unblocked, provider_revoked, agent_blocked, or agent_unblocked.
string
Notes from the moderator who resolved the case. Present after resolution.
string
Identifier of the moderator who resolved the case. Present after resolution.
string (ISO 8601)
required
UTC timestamp when this case was opened.
string (ISO 8601)
required
UTC timestamp of the most recent update to this case.

Example response