docs: document store location, corrupt file recovery, and API endpoints

- Add store location in troubleshooting section
- Explain corrupt file backup behavior with timestamps
- Add API section with GET, PUT, and DELETE endpoint documentation

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
This commit is contained in:
by-ae
2026-10-24 09:57:03 +00:00
co-authored by Cursor Agent
parent 048e0110c8
commit b3e2e53e66
+12
View File
@@ -57,6 +57,10 @@ The builder outputs a structured JSON prompt compatible with Ideogram 4's API fo
This is usually harmless. The store routes register on startup, and if they fail, character/object/scene save features may not work, but the builder itself will function normally. Check file permissions on your ComfyUI user directory.
**Store location:** Character, object, and scene presets are stored in `<ComfyUI user directory>/byae-ideogram-tools/` as JSON files (`characters.json`, `objects.json`, `scenes.json`).
**Corrupt file recovery:** If a store file becomes corrupted (invalid JSON), it will be automatically moved to a backup file named `<bucket>.json.corrupt-<timestamp>` and the bucket will be treated as empty. Other buckets continue to work normally, and saves to the recovered bucket will work immediately.
### Background image not updating
- Verify the `guid` output from the builder is connected to Preview BG Update's `guid` input
@@ -72,6 +76,14 @@ Node names and internal IDs are stable. If a workflow breaks, check:
For bugs or feature requests, please open an issue on GitHub.
## API
The extension exposes HTTP routes for programmatic access to the character/object/scene store:
- **GET** `/byae/ideogram/stores` — Load all stores (returns `{"characters": {...}, "objects": {...}, "scenes": {...}}`)
- **PUT** `/byae/ideogram/stores/{bucket}/{name}` — Save an entry (body: JSON object; bucket: `characters`, `objects`, or `scenes`)
- **DELETE** `/byae/ideogram/stores/{bucket}/{name}` — Delete an entry (returns 404 if not found, 200 on success)
## License
This project is a derivative work based on **ComfyUI-KJNodes**, in particular `Ideogram4PromptBuilderKJ` and shared frontend utilities.