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

# Quickstart

> Get started with Vambe: account setup, channels, API keys, and your first request.

## 🚀 What you'll build

You'll set up your Vambe account and channel, create an API key, and make your first API request.

<Tip>
  This guide takes about 10 minutes to complete. By the end, you'll have made
  your first successful API call to Vambe.
</Tip>

***

## 1) Prerequisites

Before you start, you'll need:

* A Vambe account with the role **Owner**

<Note>
  Don't have an account yet? Create one at
  [`app.vambeai.com/login`](https://app.vambeai.com/login)
</Note>

<Info>
  **Want to connect channels?** Check out our [Connect your first
  channel](/docs/connect-channel) guide to set up WhatsApp, Instagram, Webchat,
  or Messenger for receiving customer messages.
</Info>

***

## 2) Create your API key

<Steps>
  <Step title="Navigate to Developers">
    Go to [`app.vambeai.com/developers`](https://app.vambeai.com/developers) and open the **API Keys** section.
  </Step>

  <Step title="Create New Key">
    Click the **New API Key** button to open the creation dialog.
  </Step>

  <Step title="Configure Key Details">
    * **Name**: Give it a descriptive name (e.g., "Server", "Zapier",
      "Development") - **Role**: Choose the appropriate permission level
  </Step>

  <Step title="Select Role">
    Choose the appropriate role for your use case:

    | Role          | Description               | Use Case                     |
    | ------------- | ------------------------- | ---------------------------- |
    | `OWNER`       | Full organization control | Initial testing, admin tasks |
    | `ADMIN`       | Administrative access     | Team management              |
    | `SUPER_ADMIN` | Extended system access    | Advanced operations          |
    | `AGENT`       | Standard operations       | Daily tasks, integrations    |
  </Step>

  <Step title="Create and Store">
    Click **Create**, then reveal and copy your API key. Store it securely in your environment variables or secret manager.
  </Step>
</Steps>

<Warning>
  **Security Best Practices:** - Treat API keys like passwords—never commit them
  to git - Use environment variables: `VAMBE_API_KEY=your_key_here` - Rotate or
  delete unused keys from the Developers page - Prefer least-privilege roles for
  production keys
</Warning>

***

## 3) Your first API call

Vambe authenticates server-side requests via the `x-api-key` header. Replace `YOUR_API_KEY` with your newly created key.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    -H "x-api-key: YOUR_API_KEY" \
    https://api.vambe.me/health/ping
  ```

  ```javascript JavaScript (fetch) theme={null}
  await fetch('https://api.vambe.me/health/ping', {
    headers: { 'x-api-key': process.env.VAMBE_API_KEY },
  });
  ```

  ```python Python (requests) theme={null}
  import os, requests

  resp = requests.get(
      'https://api.vambe.me/health/ping',
      headers={'x-api-key': os.environ['VAMBE_API_KEY']}
  )
  ```
</CodeGroup>

### Expected Response

```json theme={null}
{
  "status": "ok",
  "message": "pong",
  "date": "2025-01-01T12:00:00.000Z"
}
```

<Accordion title="Testing Tips" icon="flask">
  * **Latency simulation**: Add `?sleep=500` to test response times:
    `.../health/ping?sleep=500` - **Database health check**: Use `GET /health` for
    a full system check including database connectivity - **Postman setup**: Add a
    header `x-api-key: YOUR_API_KEY` to your request
</Accordion>

***

## 4) Next steps

<Check>
  Congratulations! You've successfully made your first API call to Vambe.
</Check>

Here's what to explore next:

<CardGroup cols={2}>
  <Card title="API Reference" icon="code" href="/reference">
    Explore all available endpoints for channels, contacts, and webhooks
  </Card>

  <Card title="Integration Guide" icon="plug" href="/docs/integration-to-the-api">
    Learn how to integrate Vambe into your existing workflows
  </Card>

  <Card title="Team Management" icon="users" href="https://app.vambeai.com/team">
    Invite teammates and configure role-based access
  </Card>

  <Card title="Webhooks" icon="webhook" href="/docs/webhooks">
    Set up real-time notifications for events
  </Card>
</CardGroup>

<Info>
  Need help? Contact our support team or check the **API Reference** section for
  detailed endpoint documentation.
</Info>