Skip to main content

​
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 for step-by-step examples

Mindhunters OpenAPI Specification

View the complete OpenAPI specification file

​
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

1

Log in to your workspace

Navigate to your Mindhunters workspace at https://your-subdomain.mindhunters.ai
2

Open Developer section

Click on your profile icon (top right) and select “Developer”
3

Create API token

In the Developer section, click “Create New API Token” or “Generate Token”
4

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.
Never share your API token or commit it to version control. Treat it like a password.

​
Using Your Token

Include your token in the Authorization header of every request:
cURL Example
curl -X GET https://your-subdomain.mindhunters.ai/api/v1/calls \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
JavaScript Example
const response = await fetch('https://your-subdomain.mindhunters.ai/api/v1/calls', {
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});
Python Example
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.

​
API Capabilities

The Mindhunters API provides the following functionality:

Voice Calls

Initiate AI-powered outbound calls and manage call status

Campaigns

Create and manage multi-channel communication campaigns

Contacts

Manage contact information and custom fields

WhatsApp

Send template-based WhatsApp messages

Transcriptions

Access conversation transcripts and analytics

Webhooks

Receive real-time event notifications

​
Getting Started

Quickstart Guide

Make your first API call in minutes

Authentication

Set up your API token

Webhooks

Configure real-time notifications

Error Handling

Handle errors gracefully

​
Response Format

All API responses follow a consistent JSON structure: Success Response: 
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  }
}
Error Response: 
{
  "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 for tracking your usage.

​
Support

Need help? We’re here for you:

​
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