Skip to content
Product Documentation

AI agents

BetFlux ships an Agent Skill — a folder of markdown that teaches a coding agent our datasets, filters, and query behavior. Agents that support the standard load it automatically when a request looks like a sportsbook-data question.

The skill explains the API’s data model and query behavior:

  • Artifacts are per-game Parquet files; rows are filtered locally after download.
  • On range queries, team and league also narrow game discovery.
  • sportsbook-lines and game-state-timeline require a game id.
  • --limit caps matching output rows, not downloaded rows. A limited sample should not be treated as a complete date range.

It also covers credential setup, dataset columns, timestamps, and output formats.

Install the BetFlux CLI, then run the command for each agent you use:

Terminal window
uv tool install betflux
betflux plugin install --claude
betflux plugin install --codex

The CLI’s automatic updates and the agent plugin’s updates are separate. The CLI updater is enabled by default on Linux and macOS; set BETFLUX_NO_AUTO_UPDATE=1 for CI or reproducible scripts. Plugin updates and removal remain managed by the agent CLI.

Specify one agent per invocation; run both commands to install in both. Claude Code installs at user scope; Codex uses its native plugin manager. The agent CLI must already be installed and on PATH. The wrapper registers betflux/skills, checks the repository source, and asks the agent to install the plugin. It never copies bundled skills, edits host configuration itself, or forwards BETFLUX_API_KEY to the installer.

Rerun the command to refresh the repository, update the plugin, and enable it, including a disabled installation. Manage removal in your agent. Avoid loading duplicate copies of the same skill.

betflux plugin install --cursor prints manual instructions and exits nonzero because no supported non-interactive installer is available. For local testing, clone the repository into a new ~/.cursor/plugins/local/betflux directory, reload Cursor, and check Customize. Do not overwrite an existing directory. Managed workspaces may need Allow Local Plugin Imports.

The plugin does not install the BetFlux executable or configure API credentials. You can also install directly through your agent using the commands below.

Start a new agent session after installation.

Terminal window
codex plugin marketplace add betflux/skills
codex plugin add betflux@betflux
/plugin marketplace add betflux/skills
/plugin install betflux@betflux

The skill follows the open Agent Skills standard, so it works with Cursor, OpenCode, GitHub Copilot, Gemini CLI, and others. Copy skills/betflux/ from betflux/skills into your agent’s skill directory — commonly ~/.cursor/skills/, ~/.agents/skills/, or ~/.config/opencode/skills/.

The repository also includes an OpenAI plugin manifest and a portable Agent Plugins 1.0 manifest. Public directory listing requires a separate vendor submission. The package contains skills only: execution needs a shell or Python runtime, network access, and a securely configured BETFLUX_API_KEY. It does not provide a hosted MCP connection. When the host lacks these capabilities, the skill can prepare commands for you to run locally. Persistent authenticated ChatGPT access requires a separate remote MCP/OAuth integration under OpenAI’s submission guidance; that service is not part of this package.

Terminal window
betflux agent-guide

Prints the skill to stdout. An agent with shell access can read that directly — useful in a sandbox where you would rather not write to a home directory.

https://api.betflux.ai/llms.txt covers the same ground for the HTTP API.

The skill reads BETFLUX_API_KEY from the environment and instructs the agent never to print it. Set it in your shell profile rather than pasting it into a conversation:

Terminal window
export BETFLUX_API_KEY=bfx_live_...

Mint keys at betflux.ai/account/api-keys.