For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set up with your AI tools

Floe is the unified billing ledger for voice AI — one key for your voice agent's entire bill (LLM, STT, TTS, telephony, and the data and tool calls around them), metered per call and bounded by server-side budgets. And it's built so your coding agent does the setup: paste one prompt into Claude Code, Cursor, or Codex and it installs the MCP server or the CLI, provisions an agent, sets guardrails, and makes a real paid call.

You do two things. Sign in and mint a developer key; fund the balance when the Welcome Credit runs out. Your agent does everything else — see the Quickstart.


1. Copy the prompt

Read https://dev-dashboard.floelabs.xyz/agents.md and set up Floe for this project.

That URL is an executable runbook written for agents: it triages what you already have, installs the right client, states the key-handling rules, provisions an agent, and ends with a settled $0.001 payment receipt. Pointing at the URL instead of pasting instructions means your agent always reads the current version.

Or open your tool with the prompt pre-filled:

  • Claude Code — claude-cli://open?q=Read%20https%3A%2F%2Fdev-dashboard.floelabs.xyz%2Fagents.md%20and%20set%20up%20Floe%20for%20this%20project.

  • Codex — codex://new?prompt=Read%20https%3A%2F%2Fdev-dashboard.floelabs.xyz%2Fagents.md%20and%20set%20up%20Floe%20for%20this%20project.

  • Cursor — cursor://anysphere.cursor-deeplink/prompt?text=Read%20https%3A%2F%2Fdev-dashboard.floelabs.xyz%2Fagents.md%20and%20set%20up%20Floe%20for%20this%20project.

The same button lives on the dashboard home page under Set up with your AI tools.


2. Get your key

Mint a developer key (floe_live_…) at dev-dashboard.floelabs.xyz/keys and put it in your environment:

export FLOE_API_KEY=floe_live_...

Never paste a key into a chat window. Environment variables and secret managers only — agents.md tells your agent to refuse if it is asked to do otherwise. See API Keys.


3. Connect a client

Universal installer — detects your MCP clients and writes the config:

Claude Code, one line:

Any client that takes JSON (Cursor .cursor/mcp.json, VS Code, Claude Code):

One-click install links — the config carries the endpoint URL only, never a key:

73 tools, full reference: MCP Server.

--json on every command; --yes skips confirmations on destructive/money verbs; exit codes 0 ok, 1 error, 2 usage, 4 auth required, 5 payment required. The rest of the platform lives on the same bin — agents, keys, policy, pay, chat, funds, phone, and more (32 commands, dashboard parity). Full reference: Floe CLI.

Both SDKs take the agent key (floe_…), not the floe_live_… developer key: a developer key passes the client's prefix check but the proxy rejects it with wrong_credential_type. The agent key comes from npx @floelabs/cli init (minted into your OS keychain) or the dashboard — read it from FLOE_AGENT_KEY.

TypeScript:

Python:

No install. Every endpoint takes Authorization: Bearer <key> — the developer key for /v1/developer/*, the agent key for payments:

Machine-readable spec: /.well-known/openapi.yaml. See Plain HTTP / REST.


4. Prove it works

Ask your agent to make its first paid call, or run it yourself:

One real metered call against the $3 welcome credit your first agent starts with — no card required. The settled cost prints from the X-Floe-Cost-USDC receipt header; floe test --voice proves the whole STT → LLM → TTS turn on one key.


What your agent can do from here

Job
MCP tool
CLI

Create an agent + mint its runtime key

create_agent + create_agent_key

npx @floelabs/cli init

Check the setup

get_balances

floe status --json

Switch the active agent

— (CLI keychain concept)

floe use <agent>

Cap spend

set_spend_limit

floe budget set <usd> [--per day]

Full policy surface (task / api / vendor / session caps)

— (CLI only)

floe policy create --kind <k> --limit <usd>

Restrict merchants

set_allowlist_mode + add_allowlist_entry

floe allowlist set / floe allowlist add

Budget a key at mint

create_agent_key

floe keys create --budget <usd> [--window <dur>]

Rotate a runtime key

rotate_agent_key

floe keys rotate

Manage developer keys

— (CLI only)

floe devkeys create|revoke|rotate

Pause / resume an agent

pause_agent / resume_agent

floe agents pause|resume <agent>

Prove the wiring

x402_pay

floe test [--voice]

Make a metered LLM / voice call

— (CLI only)

floe chat · floe embed · floe speak · floe transcribe

Check a vendor URL's price

check_x402_url / estimate_x402_cost

floe pay <url> --check

Price an inference call

estimate_inference_cost

floe estimate --model <id> …

Browse the model catalog

list_models

floe models

Pay a vendor

x402_pay

floe pay <url>

Watch the money

get_usage_summary / get_activity

floe usage / floe activity

Billing + CSV export

— (CLI only)

floe billing mtd|invoice|export

Open a credit line

get_credit_line_bounds + open_credit_line

floe credit bounds / floe credit open

Webhooks

create_webhook / list_webhooks / test_webhook + catalog, update/delete, secret rotation

floe webhooks create|list|test|events

Webhook delivery logs

list_webhook_deliveries / get_webhook_delivery / retry_webhook_delivery

floe webhooks logs|deliveries

Move money / cash out

— (CLI only)

floe funds · floe cashout

Hand funding to a human

get_funding_instructions

floe funds address / floe funds topup

Phone, BYOK, orchestrators, team

— (CLI only)

floe phone · floe providers · floe orchestrators · floe team

Next steps

  • Quickstart — create an agent, connect your tools, first paid call

  • MCP Server — all 73 tools with input schemas

  • Floe CLI — every command, flag, and exit code

  • Spend Controls — the guardrails to set before you let it run

Last updated