Change one Hive AI policy. Enabling one is refused unless the person is an owner or admin.

post/api/v1/tools/update_ai_policy

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/update_ai_policy
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Required for every write.

Request body

goalEventstring nullable

Optional goal event, or null to clear it.

providerConnectionIdstring nullable

Saved provider connection id, or null for the workspace default.

knowledgeSourceIdsstring[]

Exact knowledge source ids to use; an empty list restores the native default.

outputSchemaobject

The policy output schema stored by Hive.

piiRedactionboolean

Redact personal information before evaluation.

injectionDefenseboolean

Enable the native injection checks.

retentionDaysinteger

Stored result retention, from 0 to 3650 days.

policyIdstring required

The policy to change.

namestring
instructionstring
policyTypestring
allowedTopicsstring[]
blockedTopicsstring[]
languagesstring[]
tonestring
confidenceThresholdnumber
requireCitationsboolean
requireHumanApprovalboolean
fallbackActionstring
status'draft' | 'enabled' | 'paused' | 'archived' | 'disabled'

Native lifecycle status. The legacy disabled value is accepted as paused.

Response

Tool result

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.