A simpler way to build agent-native APIs.

---

Website: https://statespace.com

Documentation: https://docs.statespace.com

---

Statespace is a web framework for building APIs that agents use to understand and work with your data with. Build APIs for RAG, text-to-SQL, knowledge bases, and more. Once you’ve created an app, you can deploy, manage, and share it from our cloud platform.

Installation

Install the CLI:

curl -fsSL https://statespace.com/install.sh | bash

Example

1. Create it

Create a file README.md with:

---
tools:
    - [date]
---

```component
echo "Hello, world!"
```

This is an example application.

# Instructions
- Check the current timestamp with `date`

2. Run it

statespace serve .

3. Ask it

Pass the URL to your agents:

claude "What can I do with the API at http://127.0.0.1:8000?"

4. Update it

Add data files, scripts, and more Markdown pages to your app:

demo/
├── README.md           # from above
├── script.py
├── data.db
├── data/
│   ├── log1.txt
│   ├── log2.txt
│   └── ...
└── knowledge/
    ├── kubernetes.md   # declares K8s tools
    └── networking.md   # declares networking tools

Then update README.md with more tools and instructions:

---
tools:
  - [date]
  - [grep, -r]
  - [python3, script.py, { }]
  - [sqlite3, data.db, { regex: "^SELECT\\b.*" }]
---

```component
echo "Hello, world!"
```

# Instructions
- Check the current timestamp with `date`
- Search through files with `grep`
- Analyze and summarize logs with `script.py`
- Run read-only queries against `data.db`
- Browse `./knowledge` for infrastructure context

5. Deploy it

Optionally, create a free Statespace account and deploy your app to the cloud:

statespace deploy . --public

More examples

See the examples/ directory for ready-to-run apps:

• rag — Search and analyze log files with grep
• knowledge_base — Navigate a multi-page documentation tree
• text_to_sql — Query a SQLite database with natural language
• workflow — Chain API calls to track the ISS and its trajectory
• agent_skill — An agent skill for using the Statespace CLI
• toolkit — Python scripts for querying Reddit

Concepts

Tools — Give agents controlled access to CLI commands over HTTP.

---
tools:
  - [date]
  - [grep, -r]
  - [python3, script.py, { }]
  - [sqlite3, data.db, { regex: "^SELECT\\b.*" }]
---

Components — Render live data inside pages with component code blocks.

```component
echo "Hello, world!"
```

Instructions — Guide agents through your data, workflows, and pages.

# Instructions
- Check the current timestamp with `date`
- Search through files with `grep`
- Analyze and summarize logs with `script.py`
- Run read-only queries against `data.db`
- Browse `./knowledge` for infrastructure context

Features

✅ Simple — It's just Markdown. Easy to learn, easy to use, easy to maintain.

⚡ Lightweight — Install a single, lightning-fast Rust binary. No dependencies.

🌐 Universal — Works directly with any agent that can make HTTP requests.

📦 Portable — Run or deploy your apps with a single CLI command.

🔒 Secure — Restrict access to your private apps with token-based authentication.

Community & Contributing

• Discord: Join our community server for real-time help and discussions
• X: Follow us @statespace_tech for updates and news
• Issues: Report bugs or request features on GitHub Issues

License

This project is licensed under the terms of the MIT license.