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

# Introduction

> Complete API reference for the Mindhunters platform

## Welcome

The Mindhunters API enables you to build AI-powered voice and text conversation experiences. This section contains automatically generated documentation for all available endpoints.

There are two ways to access API documentation:

1. **Auto-generated Reference** - Browse the endpoints in the sidebar (generated from our OpenAPI specification)
2. **Interactive Guides** - Check our [Quickstart Guide](/quickstart) for step-by-step examples

<Card title="Mindhunters OpenAPI Specification" icon="code" href="https://app.mindhunters.ai/docs/api-docs.json">
  View the complete OpenAPI specification file
</Card>

## Base URL

All API requests should be made to your workspace-specific URL:

```
https://{subdomain}.mindhunters.ai/api/v1
```

Replace `{subdomain}` with your workspace identifier. For example, if your workspace URL is `https://abc.mindhunters.ai`, then your API base URL is `https://abc.mindhunters.ai/api/v1`.

## Authentication

All API endpoints require authentication using Bearer tokens.

### How to Get Your API Token

<Steps>
  <Step title="Log in to your workspace">
    Navigate to your Mindhunters workspace at `https://your-subdomain.mindhunters.ai`
  </Step>

  <Step title="Open Developer section">
    Click on your profile icon (top right) and select **"Developer"**
  </Step>

  <Step title="Create API token">
    In the Developer section, click **"Create New API Token"** or **"Generate Token"**
  </Step>

  <Step title="Copy and store securely">
    Copy the generated token immediately. You won't be able to see it again after closing the dialog.

    Store it securely in environment variables or a secrets manager.
  </Step>
</Steps>

<Warning>
  Never share your API token or commit it to version control. Treat it like a password.
</Warning>

### Using Your Token

Include your token in the `Authorization` header of every request:

```bash cURL Example theme={null}
curl -X GET https://your-subdomain.mindhunters.ai/api/v1/calls \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

```javascript JavaScript Example theme={null}
const response = await fetch('https://your-subdomain.mindhunters.ai/api/v1/calls', {
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});
```

```python Python Example theme={null}
import requests

headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(
    "https://your-subdomain.mindhunters.ai/api/v1/calls",
    headers=headers
)
```

For detailed authentication setup, see our [Authentication Guide](/authentication).

## API Capabilities

The Mindhunters API provides the following functionality:

<CardGroup cols={2}>
  <Card title="Voice Calls" icon="phone">
    Initiate AI-powered outbound calls and manage call status
  </Card>

  <Card title="Campaigns" icon="bullhorn">
    Create and manage multi-channel communication campaigns
  </Card>

  <Card title="Contacts" icon="address-book">
    Manage contact information and custom fields
  </Card>

  <Card title="WhatsApp" icon="message">
    Send template-based WhatsApp messages
  </Card>

  <Card title="Transcriptions" icon="file-lines">
    Access conversation transcripts and analytics
  </Card>

  <Card title="Webhooks" icon="webhook">
    Receive real-time event notifications
  </Card>
</CardGroup>

## Getting Started

<CardGroup cols={2}>
  <Card title="Quickstart Guide" icon="rocket" href="/quickstart">
    Make your first API call in minutes
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Set up your API token
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks">
    Configure real-time notifications
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/errors">
    Handle errors gracefully
  </Card>
</CardGroup>

## Response Format

All API responses follow a consistent JSON structure:

**Success Response:**

```json theme={null}
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  }
}
```

**Error Response:**

```json theme={null}
{
  "success": false,
  "message": "Error description",
  "error": {
    "code": "ERROR_CODE",
    "details": "Additional error information"
  }
}
```

## Rate Limits

* **API Requests:** 1000 requests per minute
* **Concurrent Calls:** 50 simultaneous calls
* **Webhook Deliveries:** 100 events per second

See the [Monitoring Guide](/monitoring) for tracking your usage.

## Support

Need help? We're here for you:

* **Documentation:** Browse our [comprehensive guides](/introduction)
* **API Reference:** Explore endpoints in the sidebar
* **Email Support:** [support@mindhunters.ai](mailto:support@mindhunters.ai)
* **Monitoring:** Track requests in your [dashboard](https://app.mindhunters.ai)

## Explore the API

Browse the endpoints in the sidebar to see detailed documentation for each API call, including:

* Request parameters and body schemas
* Response formats
* Authentication requirements
* Code examples
* Error codes