> ## Documentation Index
> Fetch the complete documentation index at: https://floodgate.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create an API key and send your first Floodgate request.

Use any OpenAI-compatible client, SDK, or coding agent with Floodgate.

<Steps>
  <Step title="Create an API key">
    Sign in to Floodgate, navigate to the **Tokens** page, and create a new key. Copy it securely, as you will not be able to view it again.
  </Step>

  <Step title="Save the key in your environment">
    <CodeGroup>
      ```bash macOS and Linux theme={null}
      export FLOODGATE_API_KEY="YOUR_API_KEY"
      ```

      ```powershell Windows PowerShell theme={null}
      $env:FLOODGATE_API_KEY = "YOUR_API_KEY"
      ```
    </CodeGroup>
  </Step>

  <Step title="List available models">
    Query the API to see all models enabled for your account:

    ```bash theme={null}
    curl "https://api.floodgate.dev/v1/models" \
      -H "Authorization: Bearer $FLOODGATE_API_KEY"
    ```
  </Step>

  <Step title="Send your first chat completion">
    ```bash theme={null}
    curl "https://api.floodgate.dev/v1/chat/completions" \
      -H "Authorization: Bearer $FLOODGATE_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "model": "gpt-6-sol",
        "messages": [
          {"role": "user", "content": "Explain binary search in two sentences."}
        ]
      }'
    ```
  </Step>
</Steps>

## Next Steps

<CardGroup cols={2}>
  <Card title="Codex" icon="terminal" href="/agents/codex" />

  <Card title="Claude Code" icon="terminal" href="/agents/claude-code" />

  <Card title="OpenCode" icon="terminal" href="/agents/opencode" />

  <Card title="Pi" icon="terminal" href="/agents/pi" />

  <Card title="Grok Build" icon="terminal" href="/agents/grok-build" />

  <Card title="Aider" icon="terminal" href="/agents/aider" />
</CardGroup>

Explore the rest of Floodgate's capabilities:

<CardGroup cols={2}>
  <Card title="Model Catalog" icon="sparkles" href="/models">
    Browse the full list of OpenAI, Claude, Grok, DeepSeek, and open-weight models.
  </Card>

  <Card title="Image Generation" icon="image" href="/images">
    Generate and edit images using `gpt-image-2` and `gpt-image-2.5`.
  </Card>

  <Card title="Coding Agents" icon="terminal" href="/agents/codex">
    Set up Codex, Claude Code, Grok Build, OpenCode, Pi, or Aider.
  </Card>

  <Card title="OpenAI-compatible API" icon="code" href="/openai-compatible">
    Full API reference with Python, TypeScript, and cURL snippets.
  </Card>
</CardGroup>


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