Use the UpdateWiki operation to update the display name or summary of a Wiki. Fields that are not passed in remain unchanged.
Prerequisites
-
An AgentStorage instance has been created and is in the
normalstate, and the instance endpoint and instance name have been obtained. -
An API Key has been created.
-
Wiki operations use the complete three-segment Agent Scope (
appId/tenantId/agentId). Each segment must be non-empty and cannot be*, with a maximum length of 128 bytes, and cannot contain/. Do not pass inrunId.
Request parameters
|
Field |
Type |
Required |
Description |
|
|
string |
Yes |
The name of the memory store. |
|
|
object |
Yes |
The complete three-segment Agent Scope, with the same rules as |
|
|
string |
Conditionally required |
The Wiki name. Must be non-empty, with a maximum of 256 bytes. At least one of |
|
|
string |
Conditionally required |
The Wiki summary, with a maximum of 4096 bytes. Pass an empty string to clear it. |
Request example
When using API Key authentication, pass the instance name and API Key through the x-ots-instancename and x-ots-apikey request headers.
curl -X POST https://<endpoint>/UpdateWiki \
-H "x-ots-instancename: <instance-name>" \
-H "x-ots-apikey: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"memoryStoreName": "agent_memory",
"scope": {
"appId": "app-001",
"tenantId": "user-001",
"agentId": "assistant"
},
"name": "Payment Knowledge Wiki",
"summary": "Payment domain design and operation instructions"
}'
Response
The response fields are the same as [GetWiki](./get-wiki.md#response).