Documentation

gateway.docsChoose your pathusers → configure → observe → deploy

OctaFuse is a self-hostable AI capability gateway and operations control plane. The docs follow the workflow: run it locally; configure upstreams, models, image and audio capabilities, Agent Tools, routes, and keys; use Playground / Simulator and logs when debugging; open the gateway repository reference for API fields, migrations, architecture, and deep operations.

01I want to run itLocal D1 → one-command Cloudflare deploy, Admin login, one test request.02I am integrating a systemProxy vs Admin, user API keys vs Integration Keys, and portal provisioning flows.03I am going to productionCloudflare Workers (default), Docker self-hosting, data placement, migration order.

Suggested order

Quick start → Providers → Models → Routes → Agent Tools (optional) → Users → API keys → Simulator → Deploy. Open GitHub technical reference when you need fields, SQL, architecture, or troubleshooting details.

Product Tour

Dashboard: start with operations, requests, tokens, spend, and recent errors.

Routes: review client mapping, upstream mapping, catalog rates, default factors, and Daily schedule windows in one editor.

Playground: select one Upstream Target and load a request sample before sending live traffic through it.

Configuration Pipeline

1ProvidersEndpoints, one key, status2ModelsCatalog and pricing3RoutesSurface, Pool, Target, strategy4ImagesGeneration / edit pricing5ToolsExtensible agent tools6UsersAccounts, budgets, model discounts7API KeysIssue, revoke, authenticate

Common Entry Points

Quick start Local D1 → Cloudflare deploy

Integration Proxy / Admin / key boundaries

Image generation / edit Images with token / per-image billing

Agent Tools Extensible tool APIs; web tools ship today

Playground Probe chat, responses, images, and DashScope audio capabilities

Simulator Validate responses, audio, and other full Proxy paths with a real key

Cloudflare deployment Worker + Admin + D1 (recommended)

Docker deployment Self-hosting, Postgres / MySQL, images

Troubleshooting And Governance

I want to…	Go to
Inspect whether a call succeeded	Request logs
Inspect usage and cost trends	Analytics
Inspect budget, key lifecycle, and user-side audit	Audit logs
Configure business timezone, billing currency, routing strategy, and alerts	System config
Read APIs, migrations, architecture, billing details	GitHub technical reference