◆Franklin/Docs

Account API

One BlockRun API key for models, media and data tools.

Use account credit on franklin.run

  1. Open Franklin web and choose Sign in to BlockRun.
  2. Sign in to your BlockRun account and confirm the Franklin connection. You return to Franklin automatically.
  3. Choose BlockRun credit in the Payment control. Chat, tools and media use your account balance.

No API key exists anywhere in this flow. Franklin keeps only who you are and which account you chose, and BlockRun checks that you are still a member of that account on every request. Signing out of Franklin ends the connection; so does being removed from the account.

Wallet USDC and account credit remain separate. Franklin keeps your chosen payment method when credit expires or runs out; use the billing link to top up, or explicitly choose Wallet to switch.

Team workspace identity currently uses a Base wallet signature, independently of your selected payment method. Account billing and usage are available in the BlockRun dashboard.

Register and add credits for the CLI

  1. Register or sign in.
  2. Create a key in API Keys.
  3. Add funds in Credits.

Release availability

The account API is live. Franklin requires a release containing the account API update, or a local build of that branch. Check your installed release before following this guide.

Configure Franklin

Set the key in your local environment or secret manager. Keep it out of source control, chat and browser bundles.

bash
export BLOCKRUN_API_KEY="<your-account-api-key>"
franklin start
# Also supported:
franklin proxy
franklin serve

Account requests default to https://api.blockrun.ai/v1. BLOCKRUN_API_BASE_URL is an optional endpoint override. No payment wallet, USDC deposit or chain selection is needed.

Supported product flows

Account mode covers the agent and subagents, proxy requests, LLM streaming, images, video and music generation/polling, speech, search, Signal/Surf and gateway data tools. Endpoint availability depends on the gateway and upstream provider. Wallet-signed cloud sync, wallet-owned assets, trades and marketplace signatures still require a separate wallet. Local sessions remain available.

Usage and errors

The account dashboard is authoritative for usage and remaining credits. Local cost totals and max-spend limits are estimates. Account status and franklin balance link to the account portal.

  • 401: check that the API key is valid and active.
  • 402: add account credits; Franklin does not switch to wallet payment.
  • 429: respect the rate limit and retry guidance.

Return to wallet billing

bash
unset BLOCKRUN_API_KEY
franklin setup solana

Solana is recommended for new wallets; Base and existing chain selections remain supported. Account credits and wallet USDC are separate balances.