Fast Ref / API Reference / Manage

reload_all_references()

Download Markdown

Reloads all references from their source files. References with "converted" or "missing" status are automatically skipped.

Signature

api.reload_all_references() -> dict

Return Value

{
    "success": bool,
    "message": str,
    "success_count": int,
    "failed_count": int,
    "skipped_count": int,
}

Example

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
result = api.reload_all_references()

print(result['message'])
# e.g. "Reload complete: 3 succeeded, 0 failed, 1 skipped"

Usage Example — Reload Only When Changed

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
status = api.check_file_status()

if any(s['status'] == 'outdated' for s in status['data']):
    result = api.reload_all_references()
    print(f"Reload: {result['success_count']} succeeded, {result['failed_count']} failed")
💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support