docs: streamline README layout and complete node doc coverage
This commit is contained in:
Dreaming Computers
@@ -21,43 +21,6 @@ If you find the nodes useful and are already planning to use **Kie.ai**, using t
|
||||
|
||||
Node-specific documentation is available in `web/docs`.
|
||||
|
||||
## Documentation Hub
|
||||
|
||||
Use this section as the main entry point after install.
|
||||
|
||||
- Full docs index: [`web/docs/README.md`](web/docs/README.md)
|
||||
- Example workflows:
|
||||
- [`Kie-AI-Nodes.json`](Kie-AI-Nodes.json)
|
||||
- [`Kie-AI-Banana-Pro-Grid.json`](Kie-AI-Banana-Pro-Grid.json)
|
||||
|
||||
### Kling 3.0 (Recommended Reading Order)
|
||||
- 1. [`web/docs/KIE_Kling_Elements.md`](web/docs/KIE_Kling_Elements.md)
|
||||
- 2. [`web/docs/KIE_Kling_Elements_Batch.md`](web/docs/KIE_Kling_Elements_Batch.md)
|
||||
- 3. [`web/docs/KIE_Kling3_Preflight.md`](web/docs/KIE_Kling3_Preflight.md)
|
||||
- 4. [`web/docs/KIE_Kling3_Video.md`](web/docs/KIE_Kling3_Video.md)
|
||||
|
||||
### Core Node Docs
|
||||
- Nano Banana Pro: [`web/docs/KIE_NanoBananaPro_Image.md`](web/docs/KIE_NanoBananaPro_Image.md)
|
||||
- Flux 2 I2I: [`web/docs/KIE_Flux2_I2I.md`](web/docs/KIE_Flux2_I2I.md)
|
||||
- Seedream 4.5 Text-to-Image: [`web/docs/KIE_Seedream45_TextToImage.md`](web/docs/KIE_Seedream45_TextToImage.md)
|
||||
- Seedream 4.5 Edit: [`web/docs/KIE_Seedream45_Edit.md`](web/docs/KIE_Seedream45_Edit.md)
|
||||
- Gemini LLM: [`web/docs/KIE_Gemini3Pro_LLM.md`](web/docs/KIE_Gemini3Pro_LLM.md)
|
||||
- Suno Basic: [`web/docs/KIE_Suno_Music_Basic.md`](web/docs/KIE_Suno_Music_Basic.md)
|
||||
- Suno Advanced: [`web/docs/KIE_Suno_Music_Advanced.md`](web/docs/KIE_Suno_Music_Advanced.md)
|
||||
|
||||
### Video Node Docs
|
||||
- Kling 2.5 I2V Pro: [`web/docs/KIE_Kling25_I2V_Pro.md`](web/docs/KIE_Kling25_I2V_Pro.md)
|
||||
- Kling 2.6 I2V: [`web/docs/KIE_Kling26_I2V.md`](web/docs/KIE_Kling26_I2V.md)
|
||||
- Kling 2.6 Motion I2V: [`web/docs/KIE_Kling26Motion_I2V.md`](web/docs/KIE_Kling26Motion_I2V.md)
|
||||
- Kling 2.6 T2V: [`web/docs/kie_kling26_t2v.md`](web/docs/kie_kling26_t2v.md)
|
||||
- Seedance V1 Pro Fast I2V: [`web/docs/KIE_SeedanceV1Pro_Fast_I2V.md`](web/docs/KIE_SeedanceV1Pro_Fast_I2V.md)
|
||||
|
||||
### Helper Node Docs
|
||||
- Get Remaining Credits: [`web/docs/KIE_GetRemainingCredits.md`](web/docs/KIE_GetRemainingCredits.md)
|
||||
- GridSlice: [`web/docs/KIE_GridSlice.md`](web/docs/KIE_GridSlice.md)
|
||||
- Prompt Grid JSON Parser: [`web/docs/kie_prompt_grid.md`](web/docs/kie_prompt_grid.md)
|
||||
- System Prompt Selector: [`web/docs/KIE_SystemPrompt_Selector.md`](web/docs/KIE_SystemPrompt_Selector.md)
|
||||
|
||||
## API Key Setup
|
||||
|
||||
To use these nodes, you must provide your own Kie.ai API key.
|
||||
@@ -143,7 +106,19 @@ This node pack currently includes the following nodes:
|
||||
- Outputs `kling_data` for direct chaining into `Kling 3.0 (Video)`.
|
||||
- Recommended before using Kling 3.0 generation while the node is in development.
|
||||
|
||||
Each node has its own documentation page under `web/docs/` with detailed inputs, outputs, and usage examples.
|
||||
## Documentation Hub
|
||||
|
||||
Use this section after reviewing Current Available Nodes.
|
||||
|
||||
- Full docs index (all nodes): [`web/docs/README.md`](web/docs/README.md)
|
||||
- Recommended Kling 3 reading order:
|
||||
- [`web/docs/KIE_Kling_Elements.md`](web/docs/KIE_Kling_Elements.md)
|
||||
- [`web/docs/KIE_Kling_Elements_Batch.md`](web/docs/KIE_Kling_Elements_Batch.md)
|
||||
- [`web/docs/KIE_Kling3_Preflight.md`](web/docs/KIE_Kling3_Preflight.md)
|
||||
- [`web/docs/KIE_Kling3_Video.md`](web/docs/KIE_Kling3_Video.md)
|
||||
- Example workflows:
|
||||
- [`Kie-AI-Nodes.json`](Kie-AI-Nodes.json)
|
||||
- [`Kie-AI-Banana-Pro-Grid.json`](Kie-AI-Banana-Pro-Grid.json)
|
||||
|
||||
## Included Example Workflows
|
||||
|
||||
@@ -201,7 +176,9 @@ Feel free to adapt, simplify, or remix them to fit your own pipelines.
|
||||
- 2026-02-03: Suno Music nodes now return two songs and two cover images.
|
||||
- 2026-02-11: Added Kling 3.0 video node and helper nodes for Kling elements + element batching.
|
||||
- 2026-02-11: Added Kling 3.0 preflight node to validate and preview request payloads before generation.
|
||||
- 2026-02-11: Added direct documentation hub links in README for faster onboarding and usage lookup.
|
||||
- 2026-02-11: Standardized Kling 3 preflight/task chaining on `kling_data`.
|
||||
- 2026-02-11: Updated Kling 3 payload compatibility (aspect ratio + multi-shot sound handling).
|
||||
- 2026-02-11: Cleaned up README structure and added docs index coverage for all public nodes.
|
||||
|
||||
## About Kie.ai
|
||||
Kie.ai is a unified API and model marketplace for image, video, and audio generation. This project is community-maintained and not affiliated with Kie.ai. Learn more at [https://kie.ai](https://kie.ai?ref=e7565cf24a7fad4586341a87eaf21e42).
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# KIE Get Remaining Credits
|
||||
|
||||
Check remaining KIE account credits using the API key from `config/kie_key.txt`.
|
||||
|
||||
## Inputs
|
||||
- `log` (BOOLEAN, optional): Enable console logging (default: `true`).
|
||||
|
||||
## Outputs
|
||||
- `data` (STRING): Raw JSON response from the credits endpoint.
|
||||
- `credits_remaining` (INT): Parsed remaining credit balance.
|
||||
|
||||
## Notes
|
||||
- This node is useful as a first smoke test after setup.
|
||||
- If the API key is missing or invalid, the node raises an error.
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# KIE Seedance 1.5 Pro (I2V/T2V)
|
||||
|
||||
Generate video from a prompt using Seedance 1.5 Pro, with optional reference images.
|
||||
|
||||
## Inputs
|
||||
- `prompt` (STRING, required): Prompt text (minimum 3 characters).
|
||||
- `images` (IMAGE, optional): Reference image batch; up to 2 images are uploaded (extra images are ignored).
|
||||
- `aspect_ratio` (COMBO, optional): `1:1`, `21:9`, `4:3`, `3:4`, `16:9`, `9:16` (default: `1:1`).
|
||||
- `resolution` (COMBO, optional): `480p`, `720p` (default: `720p`).
|
||||
- `duration` (COMBO, optional): `4`, `8`, `12` seconds (default: `8`).
|
||||
- `fixed_lens` (BOOLEAN, optional): Lock camera lens behavior.
|
||||
- `generate_audio` (BOOLEAN, optional): Enable audio generation.
|
||||
- `log` (BOOLEAN, optional): Enable helper logging (default: `true`).
|
||||
|
||||
## Outputs
|
||||
- `video` (VIDEO): SaveVideo-compatible ComfyUI video output.
|
||||
|
||||
## Notes
|
||||
- No images connected = text-to-video mode.
|
||||
- If images are connected, they are uploaded and sent as `input_urls`.
|
||||
- Input enums are strict and validated before createTask submission.
|
||||
@@ -0,0 +1,16 @@
|
||||
# KIE Seedream 4.5 Text-To-Image
|
||||
|
||||
Generate an image from a text prompt using Seedream 4.5.
|
||||
|
||||
## Inputs
|
||||
- `prompt` (STRING, required): Generation prompt text.
|
||||
- `aspect_ratio` (COMBO, optional): `1:1`, `4:3`, `3:4`, `16:9`, `9:16`, `2:3`, `3:2`, `21:9` (default: `1:1`).
|
||||
- `quality` (COMBO, optional): `basic`, `high` (default: `basic`).
|
||||
- `log` (BOOLEAN, optional): Enable helper logging (default: `true`).
|
||||
|
||||
## Outputs
|
||||
- `image` (IMAGE): ComfyUI image tensor (BHWC float32, 0..1).
|
||||
|
||||
## Notes
|
||||
- This node is text-to-image only (no image input required).
|
||||
- Polling and timeout are handled internally by shared helpers.
|
||||
|
||||
@@ -14,6 +14,7 @@ This folder contains node documentation for the ComfyUI KIE API pack.
|
||||
- Kling 2.6 Motion I2V: [`KIE_Kling26Motion_I2V.md`](KIE_Kling26Motion_I2V.md)
|
||||
- Kling 2.6 T2V: [`kie_kling26_t2v.md`](kie_kling26_t2v.md)
|
||||
- Seedance V1 Pro Fast I2V: [`KIE_SeedanceV1Pro_Fast_I2V.md`](KIE_SeedanceV1Pro_Fast_I2V.md)
|
||||
- Seedance 1.5 Pro I2V/T2V: [`KIE_Seedance15Pro_I2V.md`](KIE_Seedance15Pro_I2V.md)
|
||||
|
||||
## Image Nodes
|
||||
- Nano Banana Pro: [`KIE_NanoBananaPro_Image.md`](KIE_NanoBananaPro_Image.md)
|
||||
|
||||
@@ -6,6 +6,16 @@ This node requires a wired STRING input for `json_text`. It does not provide a m
|
||||
|
||||
---
|
||||
|
||||
## Inputs
|
||||
|
||||
- `json_text` (STRING, required): Wired JSON text from an upstream node.
|
||||
- `max_items` (INT, optional): Maximum prompts to return (1..9).
|
||||
- `strict` (BOOLEAN, optional): Fail hard when parse fails or prompts are missing.
|
||||
- `default_prompt` (STRING, optional): Fallback when strict mode is off.
|
||||
- `debug` (BOOLEAN, optional): Enable parser diagnostics in console.
|
||||
|
||||
---
|
||||
|
||||
## Example JSON inputs
|
||||
|
||||
Array format:
|
||||
|
||||
Reference in New Issue
Block a user