Rotate KB widget public key

POST

/api/widgets/kb/{widgetId}/rotate-key

• Production

Generate a new public key for the widget. The previous key is invalidated immediately, so any embedded instances must be updated with the new key.

Authorizations

• bearerAuth

Parameters

Path Parameters

widgetId

required

string format: uuid

The unique identifier of the widget.

Responses

200

A new public key was generated.

Response containing a newly generated public key for a widget.

object

publicKey

required

The new public key. The previous key is invalidated immediately.

string

Example

pk_wgt_x9y8z7w6v5u4

404

No widget exists with the given ID in the authenticated tenant.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found

code

A machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.

string

Example

key_lock

missing_scopes

On a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.

Array<string>

Example

[
  "mcp:write"
]

entryId

On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.

string format: uuid

Example

11223344-5566-4788-99aa-bbccddeeff00

connectionId

On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.

string

undeclaredTools

On the same 422: the tool names the connection does not declare.

Array<string>

Example

[
  "get_orders"
]

declaredTools

On the same 422: the tools the connection declares.

Array<string>

Example

[
  "get_order",
  "search_orders"
]