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

# Quickstart

> Get up and running with the Zeplo API in under 5 minutes.

# Quickstart

Send your first WhatsApp message with the Zeplo API in a few simple steps.

## Get Your API Key

**1. Sign up for Zeplo**

Create an account at [app.zeplo.ai](https://app.zeplo.ai) and complete the onboarding flow. You'll need a WhatsApp Business Account linked to your Meta Business Manager.

**2. Connect a WhatsApp Channel**

Navigate to **Settings > Channels** and use the Embedded Signup flow to connect your WhatsApp Business Account. Copy the **Channel ID** shown after setup.

**3. Create an API Key**

Go to **Settings > API Keys** and click **Create Key**. Give it a name (e.g., "My Integration"), select the permissions you need, and set rate limits.

**4. Save Your Credentials**

Copy the API key and secret immediately — the secret is only shown once. Store them securely using environment variables or a secrets manager.

> [!WARNING]
>
> Keep your API key and secret secure. Never expose them in client-side code, public repositories, or browser localStorage. Use environment variables on your server.

## Choose Your SDK

**JavaScript/TypeScript**

Install the Zeplo client using npm or yarn:

```bash theme={null}
npm install @zeplo/sdk
```

```typescript theme={null}
import { ZeploClient } from '@zeplo/sdk';

const zeplo = new ZeploClient({
  apiKey: process.env.ZEPLO_API_KEY,
  apiSecret: process.env.ZEPLO_API_SECRET,
  channelId: process.env.ZEPLO_CHANNEL_ID,
});

// Send a template message
const message = await zeplo.messages.sendTemplate({
  to: '919876543210',
  templateName: 'hello_world',
  languageCode: 'en',
});

console.log('Message sent:', message.data.messageId);
```

```typescript theme={null}
// Create a contact
const contact = await zeplo.contacts.create({
  name: 'John Doe',
  phone: '919876543210',
  email: 'john@example.com',
  tags: ['customer', 'vip'],
});

console.log('Contact created:', contact.data.id);
```

**Python**

Install the Zeplo client using pip:

```bash theme={null}
pip install zeplo
```

```python theme={null}
from zeplo import ZeploClient

client = ZeploClient(
    api_key="ZEPLO_API_KEY",
    api_secret="ZEPLO_API_SECRET",
    channel_id="ZEPLO_CHANNEL_ID",
)

# Send a template message
message = client.messages.send_template(
    to="919876543210",
    template_name="hello_world",
    language_code="en",
)

print(f"Message sent: {message.data.message_id}")
```

```python theme={null}
# Create a contact
contact = client.contacts.create(
    name="John Doe",
    phone="919876543210",
    email="john@example.com",
    tags=["customer", "vip"],
)

print(f"Contact created: {contact.data.id}")
```

## Direct API Call

You can also call the REST API directly without an SDK:

```bash cURL theme={null}
curl -X POST https://zeplo.ai/api/v1/messages/template \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "x-channel-id: YOUR_CHANNEL_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "919876543210",
    "templateName": "hello_world",
    "languageCode": "en"
  }'
```

## Next Steps

> **[Authentication](https://docs.zeplo.ai/docs/authentication.md)**
>
> Learn about API key and session-based authentication methods.

> **[Messaging](https://docs.zeplo.ai/docs/features/messaging.md)**
>
> Explore all message types: text, images, documents, templates, and more.

> **[Contacts](https://docs.zeplo.ai/docs/features/contacts.md)**
>
> Create, update, group, and manage your WhatsApp contacts.

> **[Campaigns](https://docs.zeplo.ai/docs/features/campaigns.md)**
>
> Set up bulk messaging campaigns with scheduling and analytics.

> **[Webhooks](https://docs.zeplo.ai/docs/features/webhooks.md)**
>
> Receive real-time event notifications for messages and conversations.

> **[API Reference](https://docs.zeplo.ai/docs/api-reference/overview.md)**
>
> Explore all REST API endpoints with interactive playgrounds.


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