Skip to main content

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.

Metadata

Release files for forkflux-api 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for forkflux-api 0.6.0
File Size Uploaded Provenance Actions
forkflux_api-0.6.0.tar.gz 27.3 kB Without provenance Details for forkflux_api-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for forkflux-api 0.6.0
File Interpreter ABI Platform Actions
forkflux_api-0.6.0-py3-none-any.whl Python 3 none any Details for forkflux_api-0.6.0-py3-none-any.whl

Total release size: 67.2 kB

Release files / forkflux_api-0.6.0.tar.gz

Download URL forkflux_api-0.6.0.tar.gz
Size 27.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6aa605e4d90c761d5fcbe0958abea89dfbaf471f34c837f60c39231e6e0f67a4
BLAKE2b-256 checksum
How to use checksums
f116b48792db78a9ea2701480e6994b789c655712c9acbc14f8823b1545eb507
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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}

Release files / forkflux_api-0.6.0-py3-none-any.whl

Download URL forkflux_api-0.6.0-py3-none-any.whl
Size 39.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5f86ddb6b17438cdbe51dd688666cc0164578d0f17c42fb95bba91629afdac2d
BLAKE2b-256 checksum
How to use checksums
40c839fe515cdf2c1e6b79ac441c5a7eedf5af7350ed405d0e7e6429348af688
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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}

Security for forkflux-api 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page