Skip to main content
POST
/
conversations
curl -X POST "https://call.aiployees.com/api/conversations" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "widget",
    "variables": {
      "customer_name": "John Smith",
      "company": "Acme Corp",
      "source": "pricing_page"
    }
  }'
{
  "status": true,
  "conversation_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "history": [
    {
      "role": "assistant",
      "content": "Hello John Smith! Welcome to Acme Corp support. How can I help you today?"
    }
  ]
}
Този endpoint създава нова сесия за разговор с AI асистент. Използвайте го за инициране на текстова чат сесия чрез вашия уеб widget или приложение.

Request Body

assistant_id
string
required
UUID на асистента, с който да започне разговора. Трябва да бъде валиден UUID на асистент, който съществува в системата.
type
string
default:"widget"
Типът на разговора. Възможни стойности:
  • widget - Разговор чрез уеб widget (по подразбиране, таксуван)
  • test - Тестов разговор (безплатен, за разработка)
variables
object
Персонализирани променливи за предаване към асистента. Тези променливи могат да се използват в системния prompt на асистента и първоначалното съобщение със синтаксис {{variable_name}}.Обичайни случаи на употреба:
  • Предварително попълване на клиентска информация от форми
  • Предаване на контекст от вашето приложение
  • Персонализиране на поведението на асистента за всяка сесия

Response Fields

status
boolean
Показва дали заявката е била успешна
conversation_id
string
Уникалният UUID идентификатор за създадения разговор. Използвайте този ID за последващи заявки за съобщения.
history
array
Първоначалната история на разговора. Ако асистентът има конфигурирано първоначално съобщение, то ще бъде включено тук.

Отговори при грешка

status
boolean
Ще бъде false когато възникне грешка
error
string
Съобщение за грешка, описващо какво се е объркало. Възможни стойности:
  • Assistant not found - Предоставеният assistant_id не съществува
  • Insufficient balance. Please top up your account. - Балансът в акаунта на собственика на асистента е твърде нисък
curl -X POST "https://call.aiployees.com/api/conversations" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "widget",
    "variables": {
      "customer_name": "John Smith",
      "company": "Acme Corp",
      "source": "pricing_page"
    }
  }'
{
  "status": true,
  "conversation_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "history": [
    {
      "role": "assistant",
      "content": "Hello John Smith! Welcome to Acme Corp support. How can I help you today?"
    }
  ]
}

Ценообразуване

  • Widget разговори: $0.01 на потребителско съобщение
  • Тестови разговори: Безплатни (за разработка и тестване)

Следващи стъпки

След създаване на разговор, използвайте endpoint-а Изпращане на съобщение за обмен на съобщения с асистента.