API Documentation
Glossary
Key terms and concepts in the Believe Flywheel API
Core Concepts
Flywheel
A self-reinforcing cycle where user actions automatically trigger token operations, creating positive feedback loops. Think of it as a perpetual motion machine for your token economy - the more it’s used, the more valuable it becomes for everyone involved. Business Benefit: Sustainable engagement and token utility that grows stronger over time.Pipeline
A sequence of token actions (burn, airdrop, etc.) that execute together atomically. Like a recipe that combines multiple ingredients (actions) to create a specific outcome. Example: Purchase → Burn 100 tokens → Airdrop 50 tokens to customerBatch
A collection of multiple pipelines processed together for efficiency and cost optimization. Instead of executing each pipeline separately, batches group them into a single operation. Business Benefit: Lower transaction costs and faster processing.Proof
Verifiable data that justifies why a flywheel action should occur. Every action includes proof data that gets recorded on-chain for transparency and auditability. Example:{"orderId": "12345", "amount": 99.99, "customerId": "user123"}
Security & Infrastructure
Multisig (Multi-Signature)
A wallet that requires approval from multiple parties before any transaction can execute. In Flywheel, both you and Believe must approve every action, preventing unauthorized token movements. Business Benefit: Protection against exploitation while maintaining your control.Vault Address
The public wallet address where your flywheel tokens are stored. This address is transparent and can receive contributions from your community. Key Point: You must fund this address with SOL (for fees) and tokens (for operations).Daily Limits
Maximum amounts of tokens that can be burned or airdropped per day. These caps provide additional protection against excessive token movements. Business Benefit: Risk management and predictable tokenomics.Scopes
Permissions that define what actions an API key can perform. Common scopes includeburn (destroy tokens) and airdrop (distribute tokens).
Example: An API key with only airdrop scope cannot burn tokens.
Token Operations
Burn
Permanently removing tokens from circulation, reducing total supply. This typically increases the value of remaining tokens through scarcity. Business Use: Reward user actions while creating token scarcity.Airdrop
Distributing tokens to specified wallet addresses, typically as rewards or incentives. Business Use: Reward customers, users, or community members.Buyback (Coming Soon)
Repurchasing tokens from the market, typically to reduce supply or support token price.Lock (Coming Soon)
Securing tokens with time-based release schedules (vesting), often used for team allocations or staking rewards.Unlock (Coming Soon)
Releasing previously locked tokens according to their vesting schedule.Memo
Attaching text or data to a transaction for documentation and transparency. Flywheel automatically adds proof memos to every action.API Workflow
Registration
One-time setup process that creates your flywheel configuration, generates API keys, and establishes the multisig wallet. When: Once per project (web app only at believe.app/projects).Batch Init
Compiling your pipelines into a transaction that requires approval. This creates a “proposal” that must be signed before execution. When: Every time you want to execute flywheel actions.Batch Execute
Processing the approved batch transaction and executing all pipeline actions. When: After signing the approval transaction from batch init.Status Monitoring
Checking the progress and results of batch operations. When: To track execution results or debug issues.Community & Transparency
Community Funding
The ability for anyone to send tokens to your flywheel vault address, increasing its capacity for rewards and operations. Business Benefit: Sustainable funding model that grows with community support.Public Transparency
All flywheel transactions are recorded on the Solana blockchain and can be viewed by anyone. Business Benefit: Builds trust and credibility with your community.Plug-and-Play
The concept that community members can easily “plug” tokens into your flywheel to power more operations, similar to plugging a device into a power source.Technical Terms
API Key
A unique identifier that authenticates your requests to the Flywheel API. Generated during registration with specific scopes.Base58
An encoding format used for Solana transaction signatures and addresses. You’ll see this in transaction hashes. Example:27FG487NDUAnrs79xRaycwtW3pCPb4G4664P2nFfmZkH1EEVJqmRoFEEHzXS6A6V2HsZ2bBU6QgP1JgfRx9cRPKh
Bundle ID
A hexadecimal identifier for a group of transactions processed together by Jito for better reliability. Example:d0f38d76f53a94b1fa1a0e2c6be123da7ce634afa87733939e406d39f659e68e
SOL
The native cryptocurrency of the Solana blockchain, required to pay for transaction fees.Transaction Hash (txHash)
A unique identifier for a completed blockchain transaction, used for verification and tracking.UUID (Universally Unique Identifier)
A standardized identifier format used for batch IDs and other unique identifiers. Example:550e8400-e29b-41d4-a716-446655440000