Documentation

Everything you need to integrate and optimize CostFlow for your business

Comprehensive Documentation

From setup to advanced integration

Getting Started
First steps with CostFlow
API Reference
Complete API documentation
Integrations
Connect CostFlow to your tools
API Keys
Learn how to create and use API keys to integrate CostFlow with your applications
Configuration
Advanced settings and customization options
Troubleshooting
Solving common issues

Detailed Guides

Step-by-step instructions for every feature

Getting Started
First steps with CostFlow

Installation

CostFlow is a self-hosted solution. Clone the repository and follow the installation instructions.

Configuration

Set up your PostgreSQL database and required environment variables.

First Steps

Create your first account, set up API keys, and start tracking costs.

API Reference
Complete API documentation

Authentication

Use Bearer tokens for API authentication. Include the token in the Authorization header.

Endpoints

Available endpoints for cost tracking, alert management, and data export.

Rate Limiting

Rate limits per endpoint to ensure service stability.

Integrations
Connect CostFlow to your tools

OpenAI

Integrate cost tracking for GPT-3.5, GPT-4, and GPT-4 Turbo models.

Claude

Support for Anthropic Claude models with real-time cost calculation.

Middleware

Express/Next.js middleware for seamless integration into your applications.

API Keys
Learn how to create and use API keys to integrate CostFlow with your applications

What is an API Key?

An API key is like a special password that allows your application to communicate securely with the CostFlow service.

How to Use API Keys

Create API keys from your dashboard and use them to authenticate your API requests with Bearer token authentication.

Code Examples

Find practical examples in Python, JavaScript, and cURL to integrate CostFlow into your applications.

Security Best Practices

Keep your API keys secret, use environment variables, and never commit them to version control.

Common Issues

Learn how to resolve authentication errors, rate limiting, and common API key problems.

Troubleshooting
Solving common issues

Common Issues

Solutions for the most frequently encountered problems.

Error Codes

Complete list of error codes and their meanings.

Performance

Optimization tips to improve your instance performance.

Integration Guide
Complete step-by-step guide to integrate CostFlow into any application with detailed code examples

Access our comprehensive integration guide with code examples for Python, Node.js, and Next.js applications.

Need Help Getting Started?

Our comprehensive documentation and support team are here to help you succeed

CostFlow - API Cost Tracking