v1

latestOpenAPI 3.1.02026-08-047777149.4 KB

Rules

Create a chat rule

Create a rule. Workspace and persona scopes require workspace admin; user scope is self-owned.

post/api/v3/workspaces/{workspace}/chat-config/rules

workspacestring required

Workspace short name

namestring required

rule_contentstring required

Instruction text loaded into assistant context

scope_type'workspace' | 'persona' | 'user' required

workspace/persona require workspace admin; user scope is self-owned

scope_idstring nullable

Required for persona scope (persona short name). Ignored for workspace scope and forced to the caller for user scope.

is_activeboolean

Rule created

idinteger

Unique rule identifier

namestring

rule_contentstring

The instruction loaded into assistant context

scope_type'workspace' | 'persona' | 'user'

scope_idstring nullable

Scope target (workspace name, persona full name, or user email)

workspace_namestring

is_activeboolean

created_atstring date-time

updated_atstring date-time