Create one Hive AI policy. A new policy is not enabled, so nothing answers from it until an owner or admin enables it.

post/api/v1/tools/create_ai_policy

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/create_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.

namestring required

What to call this policy.

policyTypestring required

What kind of policy it is.

instructionstring

What the AI is told to do.

allowedTopicsstring[]

What it may talk about.

blockedTopicsstring[]

What it must not.

languagesstring[]

The languages it may answer in.

tonestring

How it should sound.

confidenceThresholdnumber

How sure it must be, from 0 to 1.

requireCitationsboolean

Make it cite an approved source.

requireHumanApprovalboolean

Make a person approve each answer.

fallbackActionstring

What it does when it is not sure.

Response

Tool result

dataunknown required

Changes

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