API & Розробники

Build with the Mihu AI Platform

RESTful API, SDK та вебхуки для інтеграції AI-агентів голосового зв'язку та обміну повідомленнями у ваші застосунки. Розробляйте швидше з вичерпною документацією та прикладами.

Переглянути документацію API-консоль
99.9%
Доступність API
<100ms
Відповідь
50+
Ендпоінти
REST API
1# Initiate an outbound call


--request POST \


3  --url https://demo.mindhunters.ai/api/v1/call \


4  --header 'Authorization: Bearer <token>' \


5  --header 'Content-Type: application/json' \


--data


7    "agentId": "32d8fc98-be1e-4d32-...",


8    "participant": {


9      "number": "+1 (415) 555-0123",


10      "about": "Customer John Doe"


11    }


12  }'
requests


2


url =


headers = {


5    "Authorization": "Bearer <token>",


6    "Content-Type": "application/json"


7}


data = {


9    "agentId": "32d8fc98-be1e-4d32-...",


10    "participant": {"number": "+1 (415) 555-0123"}


11}


12response = requests.post(url, headers=headers, json=data)
1const response = await fetch(


2  'https://demo.mindhunters.ai/api/v1/call',


3  {


4    method: 'POST',


5    headers: {


6      'Authorization': 'Bearer <token>',


7      'Content-Type': 'application/json'


8    },


9    body: JSON.stringify({


10      agentId: '32d8fc98-be1e-4d32-...',


11      participant: { number: '+1 (415) 555-0123' }


12    })


13  }


14);
201 Created
QUICK START

Запуск за лічені хвилини

Get started with the Mihu AI API in three simple steps.

1

Отримайте свій API-токен

Увійдіть у свою панель керування та згенеруйте приватний API-токен із необов'язковим терміном дії.

: Bearer
2

Встановіть базову URL-адресу

Усі API-запити надсилаються на наш захищений ендпоінт з вашим bearer-токеном.

https://demo.mindhunters.ai/api/v1
3

Здійсніть свій перший дзвінок

Ініціюйте вихідний дзвінок за допомогою вашого агента та почніть автоматизувати розмови.

POST /call { agentId, participant }
AUTHENTICATION

Безпечний доступ до API

Choose between API keys for server-to-server or OAuth 2.0 for user-delegated access.

API-ключі

Генеруйте API-ключі для автентифікації запитів. Створюйте приватні токени з необов'язковими термінами дії для безпечного доступу.

Додати API-ключ
Назва API-ключа
Встановити дату закінчення дії
Безстроковий
••••••••••••••••••••••••••••••••
••••••••••••••••••••••••••••••••

OAuth 2.0

Галузева стандартна авторизація для делегованого доступу користувачів. Ідеально підходить для інтеграцій з маркетплейсами.

1

Перенаправлення на авторизацію

Перенаправте користувачів на екран згоди Mihu

GET /oauth/authorize?client_id=...
2

Отримання коду авторизації

Користувач надає дозвіл, ви отримуєте код

?code=abc123&state=xyz
3

Обмін на токен доступу

Обміняйте код на токен доступу

POST /oauth/token
Довідник API

Повна документація кінцевих точок

Explore our RESTful API with detailed request/response examples for every endpoint.

Довідник API
Дзвінок
post /call
WhatsApp
post /whatsapp/template
Записи на прийом
GET /appointments
post /appointments
Контакти
GET /contacts
post /contacts
Завдання
GET /tasks
post /tasks
Кампанії
GET /campaigns
Розклади
GET /schedules
Транскрипції
GET /transcriptions
post /api/v1/call

Ініціювати вихідний дзвінок

Ініціює вихідний дзвінок за допомогою вказаного AI-агента. Агент зателефонує на номер учасника та діятиме відповідно до налаштованих інструкцій промпту.

Параметри запиту

Параметр Тип Обов'язковий Опис
agentId string Обов'язковий UUID AI-агента для здійснення дзвінка
participant.number string Обов'язковий Номер телефону для дзвінка (формат E.164)
participant.about string Необов'язковий Контекст про учасника для AI
prompt.content string Необов'язковий Користувацький промпт для заміни стандартного промпту агента
prompt.overwrite boolean Необов'язковий Чи перезаписувати стандартний промпт
message.start string Необов'язковий Вступне повідомлення при з'єднанні дзвінка

Приклад запиту

POST /api/v1/call
application/json 
{
  "agentId": "32d8fc98-be1e-4d32-a12e-146f397fb1cb",
  "prompt": {
    "overwrite": true,
    "content": "You are Michael from the support team..."
  },
  "participant": {
    "number": "+1 (415) 555-0123",
    "about": "Customer named John Doe. Order #12345."
  },
  "message": {
    "start": "Hello! This is Michael from support."
  }
}

Відповідь

200 OK
application/json 
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "callId": "call_abc123def456",
    "status": "initiated"
  }
}
WEBHOOKS

Сповіщення про події в реальному часі

Set up Webhooks to trigger actions on external services in real-time. Stay informed on updates and changes to ensure seamless integration.

Налаштування вебхуків
Оновлення розмови
Звіт про завершення розмови
Статус розмови
Дзвінок за наміром
Оцінка тексту
Оцінка голосу
Поточне налаштування вебхука
URL: https://integration.mihu.ai/webhook/422ffbc1-5068-4e83-bbbb-297d53f09ce3
Активні події: Звіт про завершення розмови, оцінка тексту, оцінка голосу
Приклад корисного навантаження conversation.end_report 
{
  "event": "conversation.end_report",
  "timestamp": "2024-01-15T14:32:18Z",
  "data": {
    "conversation_id": "conv_abc123def456",
    "agent_id": "32d8fc98-be1e-4d32-a12e-146f397fb1cb",
    "direction": "outbound",
    "participant": {
      "number": "+1 (415) 555-0123",
      "name": "John Doe"
    },
    "duration_seconds": 187,
    "status": "completed",
    "transcript_url": "https://...",
    "recording_url": "https://...",
    "sentiment": "positive",
    "summary": "Customer inquired about order status..."
  }
}

Готові почати розробку?

Отримайте свій API-ключ і запустіть першу інтеграцію за лічені хвилини. Безкоштовний план включає 1 000 API-запитів на місяць.

Отримати API-ключ Читати документацію