API referenceEndpoints

Set platform web search limits

Requires platform-administrator authority. Generated from the production route registered in `internal/features/websearch/inbound/http.go`.

PUT/v1/admin/web-search/policy

Requires platform-administrator authority. Generated from the production route registered in internal/features/websearch/inbound/http.go.

Authorization

AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Header Parameters

If-Match*string

The strong entity tag from the most recent GET or PUT, or * for "whatever is stored now". Omitting it is 428; a tag that is not current is 412. The tag is opaque — echo it, never parse it.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

How many web searches one organization may run: a monthly number and a per-minute ceiling, replaced whole. A page read (web.read) counts like a search. The seeded platform values are 1,000 a month and 30 a minute.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/admin/web-search/policy" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "monthly_searches": 1000,    "searches_per_minute": 30  }'
{  "scope": "platform",  "version": 0,  "policy": {    "monthly_searches": 1000,    "searches_per_minute": 30  },  "effective": {    "monthly_searches": 1000,    "searches_per_minute": 30  }}