Fast Ref
/
API Reference
/
Advanced
merge_reference()
Download MarkdownConverts the specified slot's reference into regular scene objects. Removes the reference from Fast Ref tracking.
Signature
api.merge_reference(slot: int) -> dict
Parameters
| Parameter | Type | Description |
|---|---|---|
slot |
int |
Slot number to merge (0-9) |
Return Value
{"success": bool, "message": str}
Errors
| Error | Cause |
|---|---|
TypeError |
slot is not int (including bool) [v2 added] |
ValueError |
Slot is invalid or empty |
RuntimeError |
Merge operation failed |
Example
from os_fast_ref.api import FastRefAPI
api = FastRefAPI()
result = api.merge_reference(slot=0)
print(result['message'])
Note: Merge is irreversible. Use
merge_all_references()for a full batch merge.