readme.md

⚡ Grokflow

Build AI-powered apps visually — no code needed.

Grokflow is a block-based AI app builder that runs on Hugging Face Spaces, powered by xAI's Grok model. Snap together input blocks, AI blocks, and output blocks to create custom AI workflows in minutes.

---

What it does

Grokflow lets you build AI apps the same way you'd build with Lego — one block at a time. Connect blocks using {{variable}} references and hit Run All to execute the whole pipeline.

---

Block types

Block	Type	Description
📝 Text Input	Input	Free-form text the user fills in
☰ Dropdown	Input	Choose from a list of options
◉ Slider	Input	Numeric value picker with min/max/step
✦ AI Generate	AI	Generate text from a prompt template
💬 AI Chat	AI	Full multi-turn conversation with Grok
⟳ AI Transform	AI	Rewrite or edit text with a prompt
▦ Display	Output	Show the value of any variable

---

How to use

1. Add blocks

Click any block button in the toolbar to add it to your canvas.

2. Name your variables

Each block has a variable name (e.g. block_1). This is how other blocks reference its value.

3. Connect blocks

In any AI prompt, use {{variable_name}} to inject another block's value. For example:

Write a {{tone}} blog post about {{topic}}.

Where tone and topic are variable names from your input blocks.

4. Run

• Click ▶ on a single block to run just that block
• Click ▶ Run All to execute all blocks in order (inputs → AI → display)

---

Example app: Blog Post Generator

Block	Type	Config
Topic	Text Input	Variable: topic
Tone	Dropdown	Options: Professional, Casual, Funny · Variable: tone
Writer	AI Generate	Prompt: Write a {{tone}} 3-paragraph blog post about {{topic}}.
Result	Display	Shows: {{writer}}

Hit Run All → instant blog post.

---

Setup on Hugging Face Spaces

Files needed

your-space/
├── app.py
└── requirements.txt

Add your API key

1. Go to your Space → Settings → Variables and secrets
2. Add a new secret:
   • Name: XAI_API_KEY
   • Value: your xAI API key from console.x.ai

Deploy

Push both files — the Space builds automatically. Takes about 60 seconds.

---

Model

Grokflow uses xAI Grok via the OpenAI-compatible API endpoint:

https://api.x.ai/v1/chat/completions
model: grok-4-1-fast-non-reasoning

---

Tech stack

• Gradio — UI framework
• xAI Grok API — language model
• Python — all logic, no JavaScript, no HTML files

---

Tips

• Variable names must be a single word with no spaces (e.g. my_topic not my topic)
• AI blocks run in the order they appear — put inputs first, AI blocks second, display blocks last
• The AI Chat block keeps full conversation history within a session
• Use the system prompt field to give each AI block a specific persona or set of instructions

---

License

MIT — free to use, fork, and build on.