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

# Get started

> Production-ready APIs for developers. Pay only when they work.

<Tip>
  **Quick start**: Get your API key from the [Bunny Platform](https://app.bunny.build), then send it in the `X-API-Key` header with every request.
</Tip>

## <Icon icon="bolt" type="solid" /> What is Bunny?

Bunny is a developer API platform. Instead of hunting down third-party integrations, wiring up credentials, and handling inconsistent responses, you get a single key and a single base URL that covers the utility APIs every project eventually needs.

Every API on Bunny follows the same conventions: REST endpoints, JSON responses, and a shared authentication header. You pay only for successful calls — errors and timeouts are always free.

**What Bunny is not**: Bunny is not a database, a cloud provider, or a general-purpose compute platform. It is a focused catalog of production-ready utility APIs designed to ship fast and stay reliable.

<CardGroup cols={3}>
  <Card title="One key" icon="key">
    A single `bun_` key unlocks all APIs you subscribe to. No per-service credentials.
  </Card>

  <Card title="Pay on success" icon="circle-check">
    Billing only triggers on `2xx` responses. Failed calls cost nothing.
  </Card>

  <Card title="REST + JSON" icon="brackets-curly">
    All endpoints follow consistent REST conventions with JSON responses.
  </Card>
</CardGroup>

<Card title="Base URL" icon="link" horizontal>
  All requests go to: `https://api.bunny.build/api/v1`
</Card>

## <Icon icon="key" type="solid" /> Get your API key

1. Sign up at the [Bunny Platform](https://app.bunny.build)
2. Create an API token (e.g. "Production API Key")
3. Copy the token. It starts with `bun_` and is shown only once. Store it securely.

<Card title="Authentication" icon="lock" horizontal>
  Security check endpoints use **API key** authentication only. Include the header: `X-API-Key: bun_your_api_key`
</Card>

## <Icon icon="terminal" type="solid" /> First request

<CodeGroup>
  ```bash cURL - Temporary email check theme={null}
  curl "https://api.bunny.build/api/v1/temporary-email?email=user@tempmail.com" \
    -H "X-API-Key: bun_your_api_key"
  ```

  ```bash cURL - IP classify theme={null}
  curl "https://api.bunny.build/api/v1/ip-classify?ip=8.8.8.8" \
    -H "X-API-Key: bun_your_api_key"
  ```

  ```bash cURL - Translate theme={null}
  curl -X POST https://api.bunny.build/api/v1/translate \
    -H "X-API-Key: bun_your_api_key" \
    -H "Content-Type: application/json" \
    -d '{"text": "Hello world", "from": "en", "to": "pt"}'
  ```
</CodeGroup>

## <Icon icon="boxes-stacked" type="solid" /> Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/authentication">
    How to authenticate and manage API keys.
  </Card>

  <Card title="SDKs" icon="code" href="/sdks">
    Use our official SDKs for Python, TypeScript, Java, and Go.
  </Card>

  <Card title="Email" icon="envelope" href="/email">
    Disposable email detection in detail.
  </Card>

  <Card title="IP" icon="network-wired" href="/ip">
    IP classification and network types.
  </Card>
</CardGroup>