Safety

List regulation templates

get
/v1/{workspace_id}/safety/templates

List all available regulation templates and composite templates.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Responses
chevron-right
200

Successful Response

application/json
idstringRequired
namestringRequired
regulationstringRequired
descriptionstringRequired
categorystringRequired
versionstringRequired
is_compositebooleanOptionalDefault: false
template_idsstring[]Optional
get
/v1/{workspace_id}/safety/templates

Get a regulation template

get
/v1/{workspace_id}/safety/templates/{template_id}

Get a regulation template by ID, including all rules.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
template_idstringRequired
Responses
chevron-right
200

Successful Response

application/json
idstringRequired
namestringRequired
regulationstringRequired
descriptionstringRequired
categorystringRequired
versionstringRequired
is_compositebooleanOptionalDefault: false
template_idsstring[]Optional
get
/v1/{workspace_id}/safety/templates/{template_id}

Apply regulation template

post
/v1/{workspace_id}/safety/templates/{template_id}/apply

Apply a regulation template to create monitor concepts for the workspace. Concepts matching existing names are skipped unless override_existing is set.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
template_idstringRequired
Body
override_existingbooleanOptionalDefault: false
Responses
chevron-right
200

Successful Response

application/json
created_conceptsstring[]Required
skippedstring[]Required
post
/v1/{workspace_id}/safety/templates/{template_id}/apply

Get safety policy config

get
/v1/{workspace_id}/safety/config

Get the workspace safety policy configuration.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Responses
chevron-right
200

Successful Response

application/json
triage_enabledbooleanRequired
triage_modelstringRequired
triage_timeout_snumberRequired
triage_max_history_turnsintegerRequired
accumulation_enabledbooleanRequired
accumulation_window_sizeintegerRequired
accumulation_single_turn_thresholdintegerRequired
accumulation_cumulative_countintegerRequired
embedding_gate_enabledbooleanRequired
applied_template_idsstring[]Required
get
/v1/{workspace_id}/safety/config

Update safety policy config

put
/v1/{workspace_id}/safety/config

Upsert the workspace safety policy configuration.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Body
triage_enabledany ofOptional
booleanOptional
or
nullOptional
triage_modelany ofOptional
stringOptional
or
nullOptional
triage_timeout_sany ofOptional
numberOptional
or
nullOptional
triage_max_history_turnsany ofOptional
integerOptional
or
nullOptional
accumulation_enabledany ofOptional
booleanOptional
or
nullOptional
accumulation_window_sizeany ofOptional
integerOptional
or
nullOptional
accumulation_single_turn_thresholdany ofOptional
integerOptional
or
nullOptional
accumulation_cumulative_countany ofOptional
integerOptional
or
nullOptional
embedding_gate_enabledany ofOptional
booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
triage_enabledbooleanRequired
triage_modelstringRequired
triage_timeout_snumberRequired
triage_max_history_turnsintegerRequired
accumulation_enabledbooleanRequired
accumulation_window_sizeintegerRequired
accumulation_single_turn_thresholdintegerRequired
accumulation_cumulative_countintegerRequired
embedding_gate_enabledbooleanRequired
applied_template_idsstring[]Required
put
/v1/{workspace_id}/safety/config

Last updated

Was this helpful?