Core API server and coordination bus for cross-device AI agent task handoff.
Project description
ForkFlux API
Core API server and coordination bus for cross-device AI agent task handoff.
ForkFlux API is the stateful coordination layer behind ForkFlux. It gives isolated AI agents a shared, machine-readable job pool for publishing work, atomically claiming tasks, transferring context and artifacts, and closing jobs with explicit lifecycle states.
Use this package when you need the ForkFlux coordination bus service itself: a FastAPI application backed by PostgreSQL or SQLite, plus a small CLI for registering target roles and agent API tokens.
What it provides
- Shared handoff queue for agent-to-agent job delegation.
- Atomic claims so only one agent can own a published job.
- Structured context transfer through job constraints, payloads, and artifacts.
- Lifecycle control for
published→in_progress→completed/failed/cancelled. - Agent identity and role registry for role-aware routing.
Package
pip install forkflux-api
The installed CLI entry point is:
forkflux --help
Runtime requirements
- Python 3.14+
See the main ForkFlux repository for local Docker setup, MCP integration, and end-to-end handoff examples.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file forkflux_api-0.2.0.tar.gz.
File metadata
- Download URL: forkflux_api-0.2.0.tar.gz
- Upload date:
- Size: 18.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09e13966128f78d1ca8693c32b075d9130adab89c067c6076ecaef98247be53f
|
|
| MD5 |
b46ea203de789154b9699168f3eea8f1
|
|
| BLAKE2b-256 |
b664156c8b607f75b5b1c6a4874fac24fbb5e6d73c62af14a5250063a6fcb0d6
|
File details
Details for the file forkflux_api-0.2.0-py3-none-any.whl.
File metadata
- Download URL: forkflux_api-0.2.0-py3-none-any.whl
- Upload date:
- Size: 29.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
995a13da7f283d403631c5959b65052606e74a09851c9d93262a9c1551a8daa4
|
|
| MD5 |
266c8c6c5902efca1a0c81dcc27bf240
|
|
| BLAKE2b-256 |
1bedc3b3fb19245c16e35576126166ac7d4502e30210eeee2f7b9020b04b64c7
|
