# Floodgate Documentation

> Simple guides for using Floodgate models with APIs and coding agents.

- [Floodgate Documentation](https://floodgate.mintlify.app/index.md): Connect your apps and coding agents to Floodgate.
- [Quickstart](https://floodgate.mintlify.app/quickstart.md): Create an API key and send your first Floodgate request.
- [Models](https://floodgate.mintlify.app/models.md): Model IDs available through Floodgate and when to use each one.
- [Refer a friend and earn $10](https://floodgate.mintlify.app/referrals.md): Invite friends to Floodgate. You both earn $10 in credits after their first $2 top-up.
- [Codex](https://floodgate.mintlify.app/agents/codex.md): Install Codex CLI and connect it to Floodgate.
- [Claude Code](https://floodgate.mintlify.app/agents/claude-code.md): Install Claude Code and route Claude Opus 5 through Floodgate.
- [OpenCode](https://floodgate.mintlify.app/agents/opencode.md): Install OpenCode and add Floodgate as a custom provider.
- [Pi](https://floodgate.mintlify.app/agents/pi.md): Install Pi and configure Floodgate models.
- [Grok Build](https://floodgate.mintlify.app/agents/grok-build.md): Install Grok Build and register Floodgate custom models.
- [Aider](https://floodgate.mintlify.app/agents/aider.md): Install Aider and use Floodgate through its OpenAI-compatible endpoint.
- [OpenAI-compatible API](https://floodgate.mintlify.app/openai-compatible.md): Use Floodgate with curl and OpenAI SDKs.
- [Troubleshooting](https://floodgate.mintlify.app/troubleshooting.md): Fix common Floodgate agent and API configuration problems.
- [Image Generation](https://floodgate.mintlify.app/images.md): Generate and edit images using GPT Image 2 and GPT Image 2.5 with Floodgate.
- [Account & Usage](https://floodgate.mintlify.app/api-reference/account-usage.md): Manage your account, check credit balance, monitor usage, and view logs via the Floodgate REST API

## Optional

- [Documentation](https://mintlify.com/docs)
- [Blog](https://mintlify.com/blog)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.