Rename Document
rename_documentChange a document's alias (doc_key). The canonical id never changes.
ref accepts the doc_… id or the current alias. The old alias keeps
resolving to the same document forever (alias_redirected warning) and is
never assigned to another document.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"ref": "<ref>",
"new_alias": "<new_alias>"
},
"name": "rename_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | Yes | ||
| new_alias | Yes | ||
| idempotency_key | No | Optional. Retries with the same key and arguments within 24 h replay the first result (replayed=true) without a second write; a different body with the same key is idempotency_key_reused. | |
| expected_version | No | ||
| session_batch_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||